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

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	applyPolicy(ObjectId policyId, boolean refresh) Applies the provided policy.
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.
Set<String>	getPermissionsForPrincipal(String principalId) Returns all permissions for the given principal from the ACL.
List<Policy>	getPolicies() Returns the applied policies if they have been fetched for this object.
List<ObjectId>	getPolicyIds() Returns the applied policy IDs if they have been fetched for this object.
long	getRefreshTimestamp() Returns the timestamp 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.
boolean	hasAllowableAction(Action action) Returns if a given action in the Allowable Actions.
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) Removes the provided policies and refreshes this object afterwards.
void	removePolicy(ObjectId policyId, boolean refresh) Removes the provided policy.
CmisObject	rename(String newName) Renames this object (changes the value of cmis:name).
ObjectId	rename(String newName, boolean refresh) Renames this object (changes the value of cmis:name).
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.
CmisObject	updateProperties(Map<String,?> properties, List<String> addSecondaryTypeIds, List<String> removeSecondaryTypeIds) Updates the provided properties and refreshes this object afterwards.
ObjectId	updateProperties(Map<String,?> properties, List<String> addSecondaryTypeIds, List<String> removeSecondaryTypeIds, 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.

Returns:

the allowable actions or null if the allowable actions have not been requested or no allowable actions are returned by the repository

CMIS:

1.0

hasAllowableAction

boolean hasAllowableAction(Action action)

Returns if a given action in the Allowable Actions.

Parameters:

action - the action to test, must not be null

Returns:

true if the action was found in the Allowable Actions, false if the action was not found in the Allowable Actions

Throws:

IllegalStateException - if the Allowable Actions haven't been fetched or provided by the repository

CMIS:

1.0

getRelationships

List<Relationship> getRelationships()

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

Returns:

the relationships to or from this object or null if the relationships have not been requested or no relationships are returned by the repository

CMIS:

1.0

getAcl

Acl getAcl()

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

CMIS:

1.0

getPermissionsForPrincipal

Set<String> getPermissionsForPrincipal(String principalId)

Returns all permissions for the given principal from the ACL.

Parameters:

principalId - the principal ID, must not be null

Returns:

the set of permissions for this user, or an empty set if principal is not in the ACL

Throws:

IllegalStateException - if the ACL hasn't been fetched or provided by the repository

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 whether only this version (false) or all versions (true ) should be deleted, the parameter is ignored for all other object types

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 - true if this object should be refreshed after the update, false if not

Returns:

the object ID of the updated object

CMIS:

1.0

updateProperties

CmisObject updateProperties(Map<String,?> properties,
                            List<String> addSecondaryTypeIds,
                            List<String> removeSecondaryTypeIds)

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. Secondary types must be supported by the repository and must have been retrieved for this object.

Parameters:

properties - the properties to update

addSecondaryTypeIds - list of secondary type IDs that should be added, may be null

removeSecondaryTypeIds - list of secondary type IDs that should be removed, may be null

Returns:

the updated object

CMIS:

1.1

updateProperties

ObjectId updateProperties(Map<String,?> properties,
                          List<String> addSecondaryTypeIds,
                          List<String> removeSecondaryTypeIds,
                          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. Secondary types must be supported by the repository and must have been retrieved for this object.

Parameters:

properties - the properties to update

addSecondaryTypeIds - list of secondary type IDs that should be added, may be null

removeSecondaryTypeIds - list of secondary type IDs that should be removed, may be null

refresh - true if this object should be refreshed after the update, false if not

Returns:

the object ID of the updated object

CMIS:

1.1

rename

CmisObject rename(String newName)

Renames this object (changes the value of cmis:name). If the repository created a new object, for example a new version, this new object is returned. Otherwise the current object is returned.

Parameters:

newName - the new name, not null or empty

Returns:

the updated object

CMIS:

1.0

rename

ObjectId rename(String newName,
                boolean refresh)

Renames this object (changes the value of cmis:name). 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:

newName - the new name, not null or empty

refresh - true if this object should be refreshed after the update, false if not

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.

Returns:

the renditions of this object or null if the renditions have not been requested or no renditions exist for this object

CMIS:

1.0

applyPolicy

void applyPolicy(ObjectId... policyIds)

Applies the provided policies and refreshes this object afterwards.

Parameters:

policyIds - the IDs of the policies to be applied

CMIS:

1.0

applyPolicy

void applyPolicy(ObjectId policyId,
                 boolean refresh)

Applies the provided policy.

Parameters:

policyId - the ID of the policy to be applied

refresh - true if this object should be refreshed after the update, false if not

CMIS:

1.0

removePolicy

void removePolicy(ObjectId... policyIds)

Removes the provided policies and refreshes this object afterwards.

Parameters:

policyIds - the IDs of the policies to be removed

CMIS:

1.0

removePolicy

void removePolicy(ObjectId policyId,
                  boolean refresh)

Removes the provided policy.

Parameters:

policyId - the ID of the policy to be removed

refresh - true if this object should be refreshed after the update, false if not

CMIS:

1.0

getPolicies

List<Policy> getPolicies()

Returns the applied policies if they have been fetched for this object. This method fetches the policy objects from the repository when this method is called for the first time. Policy objects that don't exist are ignored.

Returns:

the list of policies applied to this object or null if the policies have not been requested or no policies are applied to this object

See Also:

getPolicyIds()

CMIS:

1.0

getPolicyIds

List<ObjectId> getPolicyIds()

Returns the applied policy IDs if they have been fetched for this object. All applied policy IDs are returned, even IDs of policies that don't exist.

Returns:

the list of IDs of applied policies or null if the policies have not been requested or no policies are applied to this object

See Also:

getPolicies()

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.

Parameters:

level - the level

Returns:

the extensions at that level or null if there no extensions

CMIS:

1.0

getAdapter

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

Returns an adapter based on the given interface.

Returns:

an adapter object or null if no adapter object could be created

getRefreshTimestamp

long getRefreshTimestamp()

Returns the timestamp of the last refresh.

Returns:

the difference, measured in milliseconds, between the last refresh time and midnight, January 1, 1970 UTC.

refresh

void refresh()

Reloads this object from the repository.

Throws:

CmisObjectNotFoundException - if the object doesn't exist anymore in the repository

refreshIfOld

void refreshIfOld(long durationInMillis)

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

Throws:

CmisObjectNotFoundException - if the object doesn't exist anymore in the repository