com.fatwire.assetapi.def
Interface AttributeDef

public interface AttributeDef

This interface represents definition of an attribute

Method Summary

java.lang.String	getDescription() Returns description associated with the attribute, if any.
java.lang.String	getName() Gets the name of the attribute
AttributeDefProperties	getProperties() Returns properties associated with the attribute.
AttributeTypeEnum	getType() Gets the data type associated with the Attribute
boolean	isDataMandatory() Indicates if data for this attribute is mandatory.
boolean	isMetaDataAttribute() Indicates if this attribute is metadata type (as opposed to user defined).
void	setDescription(java.lang.String descr)
void	setIsMandatory(boolean mandatory)
void	setIsMetadataAttribute(boolean isMetaData)
void	setName(java.lang.String name)
void	setProperties(AttributeDefProperties props)
void	setType(AttributeTypeEnum type)

Method Detail

getName

java.lang.String getName()

Gets the name of the attribute

Returns:

Name of the attribute

getDescription

java.lang.String getDescription()

Returns description associated with the attribute, if any.

Returns:

Description associated with the attribute.

getType

AttributeTypeEnum getType()

Gets the data type associated with the Attribute

Returns:

data type

getProperties

AttributeDefProperties getProperties()

Returns properties associated with the attribute.

Returns:

Map of properties associated with the attribute.

isMetaDataAttribute

boolean isMetaDataAttribute()

Indicates if this attribute is metadata type (as opposed to user defined).

Returns:

true if the attribute is meta data type, false otherwise.

isDataMandatory

boolean isDataMandatory()

Indicates if data for this attribute is mandatory.

Returns:

true if the attribute is required false otherwise.

setName

void setName(java.lang.String name)

setDescription

void setDescription(java.lang.String descr)

setType

void setType(AttributeTypeEnum type)

setProperties

void setProperties(AttributeDefProperties props)

setIsMandatory

void setIsMandatory(boolean mandatory)

setIsMetadataAttribute

void setIsMetadataAttribute(boolean isMetaData)