org.apache.chemistry.opencmis.commons.definitions
Interface PropertyDefinition<T>

All Superinterfaces:
ExtensionsData, java.io.Serializable
All Known Subinterfaces:
PropertyBooleanDefinition, PropertyDateTimeDefinition, PropertyDecimalDefinition, PropertyHtmlDefinition, PropertyIdDefinition, PropertyIntegerDefinition, PropertyStringDefinition, PropertyUriDefinition

public interface PropertyDefinition<T>
extends java.io.Serializable, ExtensionsData

Base property definition interface.

Author:
Florian Müller

Method Summary
 Cardinality getCardinality()
          Returns the cardinality.
 java.util.List<Choice<T>> getChoices()
          Returns the choices for this property.
 java.util.List<T> getDefaultValue()
          Returns the default value.
 java.lang.String getDescription()
          Returns the property description.
 java.lang.String getDisplayName()
          Returns the display name.
 java.lang.String getId()
          Returns the property definition id.
 java.lang.String getLocalName()
          Returns the local name.
 java.lang.String getLocalNamespace()
          Returns the local namespace.
 PropertyType getPropertyType()
          Returns the property type.
 java.lang.String getQueryName()
          Returns the query name
 Updatability getUpdatability()
          Returns the updatability.
 java.lang.Boolean isInherited()
          Returns if the property is inherited by a parent type.
 java.lang.Boolean isOpenChoice()
          Returns if the property supports open choice.
 java.lang.Boolean isOrderable()
          Returns if the property is Orderable.
 java.lang.Boolean isQueryable()
          Returns if the property is queryable.
 java.lang.Boolean isRequired()
          Returns if the property is required.
 
Methods inherited from interface org.apache.chemistry.opencmis.commons.data.ExtensionsData
getExtensions, setExtensions
 

Method Detail

getId

java.lang.String getId()
Returns the property definition id.

Returns:
the property definition id

getLocalName

java.lang.String getLocalName()
Returns the local name.

Returns:
the local name

getLocalNamespace

java.lang.String getLocalNamespace()
Returns the local namespace.

Returns:
the local namespace

getDisplayName

java.lang.String getDisplayName()
Returns the display name.

Returns:
the display name

getQueryName

java.lang.String getQueryName()
Returns the query name

Returns:
the query name

getDescription

java.lang.String getDescription()
Returns the property description.

Returns:
returns the description

getPropertyType

PropertyType getPropertyType()
Returns the property type.

Returns:
the property type

getCardinality

Cardinality getCardinality()
Returns the cardinality.

Returns:
the cardinality

getUpdatability

Updatability getUpdatability()
Returns the updatability.

Returns:
the updatability

isInherited

java.lang.Boolean isInherited()
Returns if the property is inherited by a parent type.

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

isRequired

java.lang.Boolean isRequired()
Returns if the property is required.

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

isQueryable

java.lang.Boolean isQueryable()
Returns if the property is queryable.

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

isOrderable

java.lang.Boolean isOrderable()
Returns if the property is Orderable.

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

isOpenChoice

java.lang.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

getDefaultValue

java.util.List<T> getDefaultValue()
Returns the default value.

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

getChoices

java.util.List<Choice<T>> getChoices()
Returns the choices for this property.

Returns:
the choices or null if no choices are defined


Copyright © 2009-2011 The Apache Software Foundation. All Rights Reserved.