org.apache.chemistry.opencmis.commons.definitions

Interface PropertyDefinition<T>

All Superinterfaces:

ExtensionsData, Serializable

All Known Subinterfaces:

PropertyBooleanDefinition, PropertyDateTimeDefinition, PropertyDecimalDefinition, PropertyHtmlDefinition, PropertyIdDefinition, PropertyIntegerDefinition, PropertyStringDefinition, PropertyUriDefinition

public interface PropertyDefinition<T>
extends Serializable, ExtensionsData

Base property definition interface.

CMIS:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
Cardinality	getCardinality() Returns the cardinality.
List<Choice<T>>	getChoices() Returns the choices for this property.
List<T>	getDefaultValue() Returns the default value.
String	getDescription() Returns the property description.
String	getDisplayName() Returns the display name.
String	getId() Returns the property definition id.
String	getLocalName() Returns the local name.
String	getLocalNamespace() Returns the local namespace.
PropertyType	getPropertyType() Returns the property type.
String	getQueryName() Returns the query name
Updatability	getUpdatability() Returns the updatability.
Boolean	isInherited() Returns if the property is inherited by a parent type.
Boolean	isOpenChoice() Returns if the property supports open choice.
Boolean	isOrderable() Returns if the property is Orderable.
Boolean	isQueryable() Returns if the property is queryable.
Boolean	isRequired() Returns if the property is required.

Methods inherited from interface org.apache.chemistry.opencmis.commons.data.ExtensionsData

getExtensions, setExtensions

Method Detail

getId

String getId()

Returns the property definition id.

Returns:

the property definition id

CMIS:

1.0

getLocalName

String getLocalName()

Returns the local name.

Returns:

the local name

CMIS:

1.0

getLocalNamespace

String getLocalNamespace()

Returns the local namespace.

Returns:

the local namespace

CMIS:

1.0

getDisplayName

String getDisplayName()

Returns the display name.

Returns:

the display name

CMIS:

1.0

getQueryName

String getQueryName()

Returns the query name

Returns:

the query name

CMIS:

1.0

getDescription

String getDescription()

Returns the property description.

Returns:

returns the description

CMIS:

1.0

getPropertyType

PropertyType getPropertyType()

Returns the property type.

Returns:

the property type

CMIS:

1.0

getCardinality

Cardinality getCardinality()

Returns the cardinality.

Returns:

the cardinality

CMIS:

1.0

getUpdatability

Updatability getUpdatability()

Returns the updatability.

Returns:

the updatability

CMIS:

1.0

isInherited

Boolean isInherited()

Returns if the property is inherited by a parent type.

Returns:

true - is inherited; false - is not inherited; null - unknown (noncompliant repository)

CMIS:

1.0

isRequired

Boolean isRequired()

Returns if the property is required.

Returns:

true - is required; false - is not required; null - unknown (noncompliant repository)

CMIS:

1.0

isQueryable

Boolean isQueryable()

Returns if the property is queryable.

Returns:

true - is queryable; false - is not queryable; null - unknown (noncompliant repository)

CMIS:

1.0

isOrderable

Boolean isOrderable()

Returns if the property is Orderable.

Returns:

true - is Orderable; false - is not Orderable; null - unknown (noncompliant repository)

CMIS:

1.0

isOpenChoice

Boolean isOpenChoice()

Returns if the property supports open choice.

Returns:

true - supports open choice; false - does not support open choice; null - unknown or not applicable

CMIS:

1.0

getDefaultValue

List<T> getDefaultValue()

Returns the default value.

Returns:

the default value (list) or null if no default value is defined

CMIS:

1.0

getChoices

List<Choice<T>> getChoices()

Returns the choices for this property.

Returns:

the choices or null if no choices are defined

CMIS:

1.0