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 desc) Sets the description of the attribute
void	setIsMandatory(boolean mandatory) Sets whether the attribute is mandatory or not
void	setIsMetadataAttribute(boolean isMetaData) Sets whether the attribute is a metadata attribute
void	setName(java.lang.String name) Sets the name of the attribute
void	setProperties(AttributeDefProperties props) Sets the property of the attribute
void	setType(AttributeTypeEnum type) Sets the type of the attribute

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)

Sets the name of the attribute

Parameters:

name - the name of the attribute

setDescription

void setDescription(java.lang.String desc)

Sets the description of the attribute

Parameters:

desc - the description of the attribute

setType

void setType(AttributeTypeEnum type)

Sets the type of the attribute

Parameters:

type - the attribute type

setProperties

void setProperties(AttributeDefProperties props)

Sets the property of the attribute

Parameters:

props - the attribute properties

setIsMandatory

void setIsMandatory(boolean mandatory)

Sets whether the attribute is mandatory or not

Parameters:

mandatory - true if the attribute is mandatory (must have a value); false if not

setIsMetadataAttribute

void setIsMetadataAttribute(boolean isMetaData)

Sets whether the attribute is a metadata attribute

Parameters:

isMetaData - true if the attribute is metadata; false if not