Interface PropertyDefinition

All Superinterfaces:
ClassAttributeDefinition

@AlfrescoPublicApi public interface PropertyDefinition extends ClassAttributeDefinition
Read-only definition of a Property.
Author:
David Caruana
  • Method Details

    • getModel

      ModelDefinition getModel()
      Specified by:
      getModel in interface ClassAttributeDefinition
      Returns:
      defining model
    • getName

      QName getName()
      Specified by:
      getName in interface ClassAttributeDefinition
      Returns:
      the qualified name of the property
    • getTitle

      String getTitle()
      Deprecated.
      The problem identified in MNT-413 will still exist
    • getDescription

      String getDescription()
      Deprecated.
      The problem identified in MNT-413 will still exist
    • getTitle

      String getTitle(MessageLookup messageLookup)
      Specified by:
      getTitle in interface ClassAttributeDefinition
      Returns:
      the human-readable class title
    • getTitle

      String getTitle(MessageLookup messageLookup, Locale locale)
      Returns:
      the human-readable class title in the specified Locale, if available.
      Since:
      5.0
    • getDescription

      String getDescription(MessageLookup messageLookup)
      Specified by:
      getDescription in interface ClassAttributeDefinition
      Returns:
      the human-readable class description
    • getDescription

      String getDescription(MessageLookup messageLookup, Locale locale)
      Returns:
      the human-readable class description in the specified Locale, if available.
      Since:
      5.0
    • getDefaultValue

      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
    • isOverride

      boolean isOverride()
    • 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()
      Description copied from interface: ClassAttributeDefinition
      Is this association or property maintained by the Repository?
      Specified by:
      isProtected in interface ClassAttributeDefinition
      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)
    • getFacetable

      Facetable getFacetable()
      Returns:
      if this field shoul be faceted
    • 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

      List<ConstraintDefinition> getConstraints()
      Get all constraints that apply to the property value
      Returns:
      Returns a list of property constraint definitions