org.sakaiproject.content.metadata.model

Class MetadataType<T>

java.lang.Object

org.sakaiproject.content.metadata.model.MetadataType<T>

All Implemented Interfaces:

Serializable

public abstract class MetadataType<T>
extends Object
implements Serializable

Description of a metadata field, specifies its values, constraints and provides tools for validation, rendering and conversion

Author:

Colin Hebert

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataType()

Method Summary

Modifier and Type	Method and Description
List<String>	getContentTypeApplicable()
abstract MetadataConverter<T>	getConverter() Gets a conversion tool describing the basic conversions used by this metadata
T	getDefaultValue()
String	getDescription()
String	getName()
abstract MetadataRenderer	getRenderer() Gets a rendering tool allowing to select a template for this Metadata depending on the current action
String	getUniqueName()
abstract MetadataValidator<T>	getValidator() Gets a validation tool to enforce constraints on the metadata values
boolean	isRequired()
boolean	isTranslated()
void	setContentTypeApplicable(List<String> contentTypeApplicable)
void	setDefaultValue(T defaultValue)
void	setDescription(String description)
void	setName(String name)
void	setRequired(boolean required)
void	setTranslated(boolean translated)
void	setUniqueName(String uniqueName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetadataType

public MetadataType()

Method Detail

getUniqueName

public String getUniqueName()

setUniqueName

public void setUniqueName(String uniqueName)

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isTranslated

public boolean isTranslated()

setTranslated

public void setTranslated(boolean translated)

getDefaultValue

public T getDefaultValue()

setDefaultValue

public void setDefaultValue(T defaultValue)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getContentTypeApplicable

public List<String> getContentTypeApplicable()

setContentTypeApplicable

public void setContentTypeApplicable(List<String> contentTypeApplicable)

getRenderer

public abstract MetadataRenderer getRenderer()

Gets a rendering tool allowing to select a template for this Metadata depending on the current action

Returns:

A MetadataRenderer customizing the rendering

getConverter

public abstract MetadataConverter<T> getConverter()

Gets a conversion tool describing the basic conversions used by this metadata

Returns:

A MetadataConverter

getValidator

public abstract MetadataValidator<T> getValidator()

Gets a validation tool to enforce constraints on the metadata values

Returns:

A MetadataConverter