org.alfresco.cmis

Interface CMISPropertyDefinition

All Known Implementing Classes:

CMISBasePropertyDefinition

public interface CMISPropertyDefinition

CMIS Property Definition

Author:

andyh

Method Summary

Methods

Modifier and Type	Method and Description
CMISCardinalityEnum	getCardinality() Get the cardinality
Collection<CMISChoice>	getChoices() Get the choices available as values for this property TODO: not implemented yet
CMISDataTypeEnum	getDataType() Get the property type
String	getDefaultValue() get the default value as a String
String	getDescription() Get the description
String	getDisplayName() Get the display name
int	getMaximumLength() For variable length properties, get the maximum length allowed.
Double	getMaxValue() For Integer and Decimal properties, get the maximum value allowed
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
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?

Method Detail

getPropertyId

CMISPropertyId getPropertyId()

Get Property Id

Returns:

getOwningType

CMISTypeDefinition getOwningType()

Get Owning Type

Returns:

getQueryName

String getQueryName()

Get the query name

Returns:

getDisplayName

String getDisplayName()

Get the display name

Returns:

getDescription

String getDescription()

Get the description

Returns:

getDataType

CMISDataTypeEnum getDataType()

Get the property type

Returns:

getCardinality

CMISCardinalityEnum getCardinality()

Get the cardinality

Returns:

getChoices

Collection<CMISChoice> getChoices()

Get the choices available as values for this property TODO: not implemented yet

Returns:

isOpenChoice

boolean isOpenChoice()

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

Returns:

isRequired

boolean isRequired()

Is this property required?

Returns:

getDefaultValue

String getDefaultValue()

get the default value as a String

Returns:

getUpdatability

CMISUpdatabilityEnum getUpdatability()

Is this property updatable?

Returns:

isQueryable

boolean isQueryable()

Is this property queryable?

Returns:

isOrderable

boolean isOrderable()

Is this property orderable in queries?

Returns:

getMaximumLength

int getMaximumLength()

For variable length properties, get the maximum length allowed.

Returns:

getMinValue

Double getMinValue()

For Integer and Decimal properties, get the minimum value allowed

Returns:

getMaxValue

Double getMaxValue()

For Integer and Decimal properties, get the maximum value allowed

Returns:

getPropertyAccessor

CMISPropertyAccessor getPropertyAccessor()

Gets the property accessor (for reading / writing values)

Returns:

getPropertyLuceneBuilder

org.alfresco.opencmis.dictionary.CMISPropertyLuceneBuilder getPropertyLuceneBuilder()

Gets the property Lucene builder

Returns: