org.apache.chemistry.opencmis.client.api

Interface CmisObject

All Superinterfaces:

CmisObjectProperties, ObjectId

All Known Subinterfaces:

Document, FileableCmisObject, Folder, Item, Policy, Relationship

public interface CmisObject
extends ObjectId, CmisObjectProperties

Base interface for all CMIS objects.

Method Summary

Methods

Modifier and Type	Method and Description
Acl	addAcl(List<Ace> addAces, AclPropagation aclPropagation) Adds ACEs to the object and refreshes this object afterwards.
Acl	applyAcl(List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation) Adds and removes ACEs to the object and refreshes this object afterwards.
void	applyPolicy(ObjectId... policyIds) Applies the provided policies and refreshes this object afterwards.
void	delete() Deletes this object.
void	delete(boolean allVersions) Deletes this object.
Acl	getAcl() Returns the ACL if it has been fetched for this object.
<T> T	getAdapter(Class<T> adapterInterface) Returns an adapter based on the given interface.
AllowableActions	getAllowableActions() Returns the allowable actions if they have been fetched for this object.
List<CmisExtensionElement>	getExtensions(ExtensionLevel level) Returns the extensions for the given level.
List<Policy>	getPolicies() Returns the applied policies if they have been fetched for this object.
long	getRefreshTimestamp() Returns the timestamp (in milliseconds) of the last refresh.
List<Relationship>	getRelationships() Returns the relationships if they have been fetched for this object.
List<Rendition>	getRenditions() Returns the renditions if they have been fetched for this object.
TransientCmisObject	getTransientObject() Deprecated. Support for transient objects will be removed in the future.
void	refresh() Reloads this object from the repository.
void	refreshIfOld(long durationInMillis) Reloads the data from the repository if the last refresh did not occur within durationInMillis.
Acl	removeAcl(List<Ace> removeAces, AclPropagation aclPropagation) Removes ACEs to the object and refreshes this object afterwards.
void	removePolicy(ObjectId... policyIds) Remove the provided policies and refreshes this object afterwards.
Acl	setAcl(List<Ace> aces) Removes the direct ACE of this object, sets the provided ACEs to the object and refreshes this object afterwards.
CmisObject	updateProperties(Map<String,?> properties) Updates the provided properties and refreshes this object afterwards.
ObjectId	updateProperties(Map<String,?> properties, boolean refresh) Updates the provided properties.

Methods inherited from interface org.apache.chemistry.opencmis.client.api.ObjectId

getId

Methods inherited from interface org.apache.chemistry.opencmis.client.api.CmisObjectProperties

findObjectType, getBaseType, getBaseTypeId, getChangeToken, getCreatedBy, getCreationDate, getDescription, getLastModificationDate, getLastModifiedBy, getName, getProperties, getProperty, getPropertyValue, getSecondaryTypes, getType

Method Detail

getAllowableActions

AllowableActions getAllowableActions()

Returns the allowable actions if they have been fetched for this object.

CMIS:

1.0

getRelationships

List<Relationship> getRelationships()

Returns the relationships if they have been fetched for this object.

CMIS:

1.0

getAcl

Acl getAcl()

Returns the ACL if it has been fetched for this object.

CMIS:

1.0

delete

void delete()

Deletes this object. If this object is a document, the whole version series is deleted.

CMIS:

1.0

delete

void delete(boolean allVersions)

Deletes this object.

Parameters:

allVersions - if this object is a document this parameter defines if only this version or all versions should be deleted

CMIS:

1.0

updateProperties

CmisObject updateProperties(Map<String,?> properties)

Updates the provided properties and refreshes this object afterwards. If the repository created a new object, for example a new version, this new object is returned. Otherwise the current object is returned.

Parameters:

properties - the properties to update

Returns:

the updated object

CMIS:

1.0

updateProperties

ObjectId updateProperties(Map<String,?> properties,
                        boolean refresh)

Updates the provided properties. If the repository created a new object, for example a new version, the object id of the new object is returned. Otherwise the object id of the current object is returned.

Parameters:

properties - the properties to update

refresh - indicates if this object should be refresh after the update

Returns:

the object id of the updated object

CMIS:

1.0

getRenditions

List<Rendition> getRenditions()

Returns the renditions if they have been fetched for this object.

CMIS:

1.0

applyPolicy

void applyPolicy(ObjectId... policyIds)

Applies the provided policies and refreshes this object afterwards.

CMIS:

1.0

removePolicy

void removePolicy(ObjectId... policyIds)

Remove the provided policies and refreshes this object afterwards.

CMIS:

1.0

getPolicies

List<Policy> getPolicies()

Returns the applied policies if they have been fetched for this object.

CMIS:

1.0

applyAcl

Acl applyAcl(List<Ace> addAces,
           List<Ace> removeAces,
           AclPropagation aclPropagation)

Adds and removes ACEs to the object and refreshes this object afterwards.

Returns:

the new ACL of this object

CMIS:

1.0

addAcl

Acl addAcl(List<Ace> addAces,
         AclPropagation aclPropagation)

Adds ACEs to the object and refreshes this object afterwards.

Returns:

the new ACL of this object

CMIS:

1.0

removeAcl

Acl removeAcl(List<Ace> removeAces,
            AclPropagation aclPropagation)

Removes ACEs to the object and refreshes this object afterwards.

Returns:

the new ACL of this object

CMIS:

1.0

setAcl

Acl setAcl(List<Ace> aces)

Removes the direct ACE of this object, sets the provided ACEs to the object and refreshes this object afterwards.

Returns:

the new ACL of this object

CMIS:

1.0

getExtensions

List<CmisExtensionElement> getExtensions(ExtensionLevel level)

Returns the extensions for the given level.

CMIS:

1.0

getAdapter

<T> T getAdapter(Class<T> adapterInterface)

Returns an adapter based on the given interface.

getTransientObject

@Deprecated
TransientCmisObject getTransientObject()

Deprecated. Support for transient objects will be removed in the future.

Returns a transient object adapter.

See Also:

TransientCmisObject

getRefreshTimestamp

long getRefreshTimestamp()

Returns the timestamp (in milliseconds) of the last refresh.

refresh

void refresh()

Reloads this object from the repository.

If the object doesn't exist anymore in the repository, a CmisObjectNotFoundException is thrown.

refreshIfOld

void refreshIfOld(long durationInMillis)

Reloads the data from the repository if the last refresh did not occur within durationInMillis.

If the object doesn't exist anymore in the repository, a CmisObjectNotFoundException is thrown.