org.apache.chemistry.opencmis.client.api

Interface CmisObjectProperties

All Known Subinterfaces:

CmisObject, Document, FileableCmisObject, Folder, Item, Policy, Relationship

public interface CmisObjectProperties

Accessors to CMIS object properties.

A property might not be available because either the repository didn't provide it or a property filter was used to retrieve this object.

The property values represent a snapshot of the object when it was loaded. The object and its properties may be out-of-date if the object has been modified in the repository.

Method Summary

Modifier and Type	Method and Description
List<ObjectType>	findObjectType(String id) Returns a list of primary and secondary object types that define the given property.
ObjectType	getBaseType() Returns the base type of this CMIS object (object type identified by cmis:baseTypeId).
BaseTypeId	getBaseTypeId() Returns the id of the base type of this CMIS object (CMIS property cmis:baseTypeId).
String	getChangeToken() Returns the change token (CMIS property cmis:changeToken).
String	getCreatedBy() Returns the user who created this CMIS object (CMIS property cmis:createdBy).
GregorianCalendar	getCreationDate() Returns the timestamp when this CMIS object has been created (CMIS property cmis:creationDate).
String	getDescription() Returns the description of this CMIS object (CMIS property cmis:description).
GregorianCalendar	getLastModificationDate() Returns the timestamp when this CMIS object has been modified (CMIS property cmis:lastModificationDate).
String	getLastModifiedBy() Returns the user who modified this CMIS object (CMIS property cmis:lastModifiedBy).
String	getName() Returns the name of this CMIS object (CMIS property cmis:name).
List<Property<?>>	getProperties() Returns a list of all available CMIS properties.
<T> Property<T>	getProperty(String id) Returns a property.
<T> T	getPropertyValue(String id) Returns the value of a property.
List<SecondaryType>	getSecondaryTypes() Returns the secondary types of this CMIS object (object types identified by cmis:secondaryObjectTypeIds).
ObjectType	getType() Returns the type of this CMIS object (object type identified by cmis:objectTypeId).

Method Detail

getProperties

List<Property<?>> getProperties()

Returns a list of all available CMIS properties.

Returns:

all available CMIS properties

getProperty

<T> Property<T> getProperty(String id)

Returns a property.

Parameters:

id - the ID of the property

Returns:

the property or null if the property hasn't been requested or hasn't been provided by the repository

getPropertyValue

<T> T getPropertyValue(String id)

Returns the value of a property.

Parameters:

id - the ID of the property

Returns:

the property value or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getName

String getName()

Returns the name of this CMIS object (CMIS property cmis:name).

Returns:

the name of the object or null if the property hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getDescription

String getDescription()

Returns the description of this CMIS object (CMIS property cmis:description).

Returns:

the description of the object or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

CMIS:

1.1

getCreatedBy

String getCreatedBy()

Returns the user who created this CMIS object (CMIS property cmis:createdBy).

Returns:

the creator of the object or null if the property hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getCreationDate

GregorianCalendar getCreationDate()

Returns the timestamp when this CMIS object has been created (CMIS property cmis:creationDate).

Returns:

the creation time of the object or null if the property hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getLastModifiedBy

String getLastModifiedBy()

Returns the user who modified this CMIS object (CMIS property cmis:lastModifiedBy).

Returns:

the last modifier of the object or null if the property hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getLastModificationDate

GregorianCalendar getLastModificationDate()

Returns the timestamp when this CMIS object has been modified (CMIS property cmis:lastModificationDate).

Returns:

the last modification date of the object or null if the property hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getBaseTypeId

BaseTypeId getBaseTypeId()

Returns the id of the base type of this CMIS object (CMIS property cmis:baseTypeId).

Returns:

the base type id of the object or null if the property hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getBaseType

ObjectType getBaseType()

Returns the base type of this CMIS object (object type identified by cmis:baseTypeId).

Returns:

the base type of the object or null if the property cmis:baseTypeId hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getType

ObjectType getType()

Returns the type of this CMIS object (object type identified by cmis:objectTypeId).

Returns:

the type of the object or null if the property cmis:objectTypeId hasn't been requested or hasn't been provided by the repository

CMIS:

1.0

getSecondaryTypes

List<SecondaryType> getSecondaryTypes()

Returns the secondary types of this CMIS object (object types identified by cmis:secondaryObjectTypeIds).

Returns:

the secondary types of the object or null if the property cmis:secondaryObjectTypeIds hasn't been requested or hasn't been provided by the repository

CMIS:

1.1

findObjectType

List<ObjectType> findObjectType(String id)

Returns a list of primary and secondary object types that define the given property.

Parameters:

id - the ID of the property

Returns:

a list of object types that define the given property or null if the property couldn't be found in the object types that are attached to this object

getChangeToken

String getChangeToken()

Returns the change token (CMIS property cmis:changeToken).

Returns:

the change token of the object or null if the property hasn't been requested or hasn't been provided or isn't supported by the repository

CMIS:

1.0