PropertyDefinition (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.dictionary

Interface PropertyDefinition

All Superinterfaces:

public interface PropertyDefinition

Read-only definition of a Property.

Method Summary
String	getAnalyserResourceBundleName() Get the name of the property bundle that defines analyser mappings for this class.
List<ConstraintDefinition>	getConstraints() Get all constraints that apply to the property value
ClassDefinition	getContainerClass()
DataTypeDefinition	getDataType()
String	getDefaultValue()
String	getDescription() Deprecated. The problem identified in MNT-413 will still exist
String	getDescription(MessageLookup messageLookup)
String	getDescription(MessageLookup messageLookup, Locale locale)
org.alfresco.repo.dictionary.Facetable	getFacetable()
org.alfresco.repo.dictionary.IndexTokenisationMode	getIndexTokenisationMode()
ModelDefinition	getModel()
QName	getName()
String	getTitle() Deprecated. The problem identified in MNT-413 will still exist
String	getTitle(MessageLookup messageLookup)
String	getTitle(MessageLookup messageLookup, Locale locale)
boolean	isIndexed()
boolean	isIndexedAtomically() All non atomic properties will be indexed at the same time.
boolean	isMandatory()
boolean	isMandatoryEnforced()
boolean	isMultiValued()
boolean	isOverride()
boolean	isProtected() Is this association or property maintained by the Repository?
boolean	isStoredInIndex()
String	resolveAnalyserClassName()
String	resolveAnalyserClassName(Locale locale)

ModelDefinition getModel()

the qualified name of the property

Deprecated. The problem identified in MNT-413 will still exist

String getDescription()

Deprecated. The problem identified in MNT-413 will still exist

String getTitle(MessageLookup messageLookup)

the human-readable class title

String getTitle(MessageLookup messageLookup,
Locale locale)

the human-readable class title in the specified Locale, if available.

String getDescription(MessageLookup messageLookup)

the human-readable class description

String getDescription(MessageLookup messageLookup,
Locale locale)

the human-readable class description in the specified Locale, if available.

String getDefaultValue()

DataTypeDefinition getDataType()

the qualified name of the property type

ClassDefinition getContainerClass()

Returns the owning class's defintion

boolean isOverride()

boolean isMultiValued()

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

boolean isMandatory()

true => mandatory, false => optional

boolean isMandatoryEnforced()

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.

boolean isProtected()

Description copied from interface: ClassAttributeDefinition

Is this association or property maintained by the Repository?

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

true => indexed, false => not indexed

boolean isStoredInIndex()

true => stored in index

getIndexTokenisationMode

org.alfresco.repo.dictionary.IndexTokenisationMode getIndexTokenisationMode()

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

org.alfresco.repo.dictionary.Facetable getFacetable()

if this field shoul be faceted

boolean isIndexedAtomically()

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

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.

List<ConstraintDefinition> getConstraints()

Get all constraints that apply to the property value

Returns a list of property constraint definitions

getAnalyserResourceBundleName

String getAnalyserResourceBundleName()

Get the name of the property bundle that defines analyser mappings for this class.

the resource or null if not set.

resolveAnalyserClassName

String resolveAnalyserClassName(Locale locale)

resolveAnalyserClassName

String resolveAnalyserClassName()

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.