org.alfresco.service.cmr.dictionary
Interface PropertyDefinition

public interface PropertyDefinition

Read-only definition of a Property.

Method Summary

java.util.List	getConstraints() Get all constraints that apply to the property value
ClassDefinition	getContainerClass()
DataTypeDefinition	getDataType()
java.lang.String	getDefaultValue()
java.lang.String	getDescription()
IndexTokenisationMode	getIndexTokenisationMode()
ModelDefinition	getModel()
QName	getName()
java.lang.String	getTitle()
boolean	isIndexed()
boolean	isIndexedAtomically() All non atomic properties will be indexed at the same time.
boolean	isMandatory()
boolean	isMandatoryEnforced()
boolean	isMultiValued()
boolean	isProtected()
boolean	isStoredInIndex()

Method Detail

getModel

ModelDefinition getModel()

Returns:

defining model

getName

QName getName()

Returns:

the qualified name of the property

getTitle

java.lang.String getTitle()

Returns:

the human-readable class title

getDescription

java.lang.String getDescription()

Returns:

the human-readable class description

getDefaultValue

java.lang.String getDefaultValue()

Returns:

the default value

getDataType

DataTypeDefinition getDataType()

Returns:

the qualified name of the property type

getContainerClass

ClassDefinition getContainerClass()

Returns:

Returns the owning class's defintion

isMultiValued

boolean isMultiValued()

Returns:

true => multi-valued, false => single-valued

isMandatory

boolean isMandatory()

Returns:

true => mandatory, false => optional

isMandatoryEnforced

boolean isMandatoryEnforced()

Returns:

Returns true if the system enforces the presence of mandatory properties, or false if the system just marks objects that don't have all mandatory properties present.

isProtected

boolean isProtected()

Returns:

true => system maintained, false => client may maintain

isIndexed

boolean isIndexed()

Returns:

true => indexed, false => not indexed

isStoredInIndex

boolean isStoredInIndex()

Returns:

true => stored in index

getIndexTokenisationMode

IndexTokenisationMode getIndexTokenisationMode()

Returns:

IndexTokenisationMode.TREU => tokenised when it is indexed (the stored value will not be tokenised)

isIndexedAtomically

boolean isIndexedAtomically()

All non atomic properties will be indexed at the same time.

Returns:

true => The attribute must be indexed in the commit of the transaction. false => the indexing will be done in the background and may be out of date.

getConstraints

java.util.List getConstraints()

Get all constraints that apply to the property value

Returns:

Returns a list of property constraint definitions