org.alfresco.cmis.dictionary
Class CMISBasePropertyDefinition

java.lang.Object
  extended by org.alfresco.cmis.dictionary.CMISBasePropertyDefinition
All Implemented Interfaces:
java.io.Serializable, CMISPropertyDefinition

public class CMISBasePropertyDefinition
extends java.lang.Object
implements CMISPropertyDefinition, java.io.Serializable

CMIS Property Definition

See Also:
Serialized Form

Constructor Summary
CMISBasePropertyDefinition(CMISMapping cmisMapping, CMISPropertyId propertyId, org.alfresco.service.cmr.dictionary.PropertyDefinition propDef, CMISTypeDefinition typeDef)
          Construct
 
Method Summary
 CMISCardinalityEnum getCardinality()
          Get the cardinality
 java.util.Collection getChoices()
          Get the choices available as values for this property TODO: not implemented yet
 CMISDataTypeEnum getDataType()
          Get the property type
 java.lang.String getDefaultValue()
          get the default value as a String
 java.lang.String getDescription()
          Get the description
 java.lang.String getDisplayName()
          Get the display name
 int getMaximumLength()
          For variable length properties, get the maximum length allowed.
 java.lang.Double getMaxValue()
          For Integer and Decimal properties, get the maximum value allowed
 java.lang.Double getMinValue()
          For Integer and Decimal properties, get the minimum value allowed
 CMISTypeDefinition getOwningType()
          Get Owning Type
 CMISPropertyAccessor getPropertyAccessor()
          Gets the property accessor (for reading / writing values)
 CMISPropertyId getPropertyId()
          Get Property Id
 org.alfresco.opencmis.dictionary.CMISPropertyLuceneBuilder getPropertyLuceneBuilder()
          Gets the property Lucene builder
 java.lang.String getQueryName()
          Get the query name
 CMISUpdatabilityEnum getUpdatability()
          Is this property updatable?
 boolean isOpenChoice()
          Is this a choice where a user can enter other values (ie a list with common options)
 boolean isOrderable()
          Is this property orderable in queries?
 boolean isQueryable()
          Is this property queryable?
 boolean isRequired()
          Is this property required?
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CMISBasePropertyDefinition

public CMISBasePropertyDefinition(CMISMapping cmisMapping,
                                  CMISPropertyId propertyId,
                                  org.alfresco.service.cmr.dictionary.PropertyDefinition propDef,
                                  CMISTypeDefinition typeDef)
Construct

Parameters:
cmisMapping -
propertyId -
propDef -
typeDef -
Method Detail

getPropertyId

public CMISPropertyId getPropertyId()
Get Property Id

Specified by:
getPropertyId in interface CMISPropertyDefinition
Returns:

getOwningType

public CMISTypeDefinition getOwningType()
Get Owning Type

Specified by:
getOwningType in interface CMISPropertyDefinition
Returns:

getQueryName

public java.lang.String getQueryName()
Get the query name

Specified by:
getQueryName in interface CMISPropertyDefinition
Returns:

getDisplayName

public java.lang.String getDisplayName()
Get the display name

Specified by:
getDisplayName in interface CMISPropertyDefinition
Returns:

getDescription

public java.lang.String getDescription()
Get the description

Specified by:
getDescription in interface CMISPropertyDefinition
Returns:

getDataType

public CMISDataTypeEnum getDataType()
Get the property type

Specified by:
getDataType in interface CMISPropertyDefinition
Returns:

getCardinality

public CMISCardinalityEnum getCardinality()
Get the cardinality

Specified by:
getCardinality in interface CMISPropertyDefinition
Returns:

getMaximumLength

public int getMaximumLength()
For variable length properties, get the maximum length allowed. Unsupported.

Specified by:
getMaximumLength in interface CMISPropertyDefinition
Returns:

getMinValue

public java.lang.Double getMinValue()
Description copied from interface: CMISPropertyDefinition
For Integer and Decimal properties, get the minimum value allowed

Specified by:
getMinValue in interface CMISPropertyDefinition
Returns:

getMaxValue

public java.lang.Double getMaxValue()
Description copied from interface: CMISPropertyDefinition
For Integer and Decimal properties, get the maximum value allowed

Specified by:
getMaxValue in interface CMISPropertyDefinition
Returns:

getChoices

public java.util.Collection getChoices()
Get the choices available as values for this property TODO: not implemented yet

Specified by:
getChoices in interface CMISPropertyDefinition
Returns:

isOpenChoice

public boolean isOpenChoice()
Is this a choice where a user can enter other values (ie a list with common options)

Specified by:
isOpenChoice in interface CMISPropertyDefinition
Returns:

isRequired

public boolean isRequired()
Is this property required?

Specified by:
isRequired in interface CMISPropertyDefinition
Returns:

getDefaultValue

public java.lang.String getDefaultValue()
get the default value as a String

Specified by:
getDefaultValue in interface CMISPropertyDefinition
Returns:

getUpdatability

public CMISUpdatabilityEnum getUpdatability()
Is this property updatable?

Specified by:
getUpdatability in interface CMISPropertyDefinition
Returns:

isQueryable

public boolean isQueryable()
Is this property queryable?

Specified by:
isQueryable in interface CMISPropertyDefinition
Returns:

isOrderable

public boolean isOrderable()
Is this property orderable in queries?

Specified by:
isOrderable in interface CMISPropertyDefinition
Returns:

getPropertyAccessor

public CMISPropertyAccessor getPropertyAccessor()
Gets the property accessor (for reading / writing values)

Specified by:
getPropertyAccessor in interface CMISPropertyDefinition
Returns:

getPropertyLuceneBuilder

public org.alfresco.opencmis.dictionary.CMISPropertyLuceneBuilder getPropertyLuceneBuilder()
Gets the property Lucene builder

Specified by:
getPropertyLuceneBuilder in interface CMISPropertyDefinition
Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.