|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CmisObject
Base CMIS object. See CMIS Domain Model - section 2.1.2.
Method Summary | ||
---|---|---|
void |
addAcl(List<Ace> addAces,
AclPropagation aclPropagation)
Adds ACEs to the object. |
|
Acl |
applyAcl(List<Ace> addAces,
List<Ace> removeAces,
AclPropagation aclPropagation)
Adds and removes ACEs to the object. |
|
void |
applyPolicy(ObjectId policyId)
Applies a policy to this object. |
|
void |
delete(boolean allVersions)
Deletes this object. |
|
Acl |
getAcl()
Returns the ACL if it has been fetched for this object. |
|
Acl |
getAcl(boolean onlyBasicPermissions)
Fetches the ACL of this object from the repository. |
|
AllowableActions |
getAllowableActions()
Returns the allowable actions if they have been fetched for this object. |
|
ObjectType |
getBaseType()
Get the object's base type (maintained by the repository). |
|
BaseTypeId |
getBaseTypeId()
Get the type's base type id. |
|
String |
getChangeToken()
Get the change token for this object (maintained by the repository). |
|
String |
getCreatedBy()
Get the id of the user who created the object (maintained by the repository). |
|
GregorianCalendar |
getCreationDate()
Get the timestamp when the object was created (maintained by the repository). |
|
List<Object> |
getExtensions(ExtensionLevel level)
|
|
GregorianCalendar |
getLastModificationDate()
Get the timestamp when the object was changed (maintained by the repository). |
|
String |
getLastModifiedBy()
Get the id of the user who changed the object (maintained by the repository). |
|
String |
getName()
Get the name of this object. |
|
List<Policy> |
getPolicies()
Returns the applied policies if they have been fetched for this object. |
|
List<Property<?>> |
getProperties()
Returns all properties that have been fetched for this object. |
|
|
getProperty(String id)
Returns a property by id. |
|
|
getPropertyMultivalue(String id)
Returns a property multi-value by id. |
|
|
getPropertyValue(String id)
Returns a property (single) value by id. |
|
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. |
|
ItemIterable<Relationship> |
getRelationships(boolean includeSubRelationshipTypes,
RelationshipDirection relationshipDirection,
ObjectType type,
OperationContext context)
Fetches the relationships from or to this object from the repository. |
|
List<Rendition> |
getRenditions()
Returns the renditions if they have been fetched for this object. |
|
ObjectType |
getType()
Get the object's type. |
|
boolean |
isChanged()
Returns true, if this object has pending changes which are not synced with the backend. |
|
void |
refresh()
Reloads the data from the repository. |
|
void |
refreshIfOld(long durationInMillis)
Reloads the data from the repository if the last refresh did not occur within durationInMillis . |
|
void |
removeAcl(List<Ace> removeAces,
AclPropagation aclPropagation)
Removes ACEs to the object. |
|
void |
removePolicy(ObjectId policyId)
Remove a policy from this object. |
|
void |
setName(String name)
Set the name of this object. |
|
|
setProperty(String id,
T value)
Sets a new property single value. |
|
|
setPropertyMultivalue(String id,
List<T> value)
Sets a new property multi value. |
|
ObjectId |
updateProperties()
Updates the properties that have been set with setProperty(String, Object) or
setPropertyMultivalue(String, List) . |
|
ObjectId |
updateProperties(Map<String,?> properties)
Updates the properties that are provided. |
Methods inherited from interface org.apache.chemistry.opencmis.client.api.ObjectId |
---|
getId |
Method Detail |
---|
String getName()
Property<String> 'cmis:name'
void setName(String name)
Property<String> 'cmis:name'
String getCreatedBy()
Property<String> 'cmis:createdBy'
GregorianCalendar getCreationDate()
Property<GregorianCalendar> 'cmis:creationDate'
String getLastModifiedBy()
Property<String> 'cmis:lastModifiedBy'
GregorianCalendar getLastModificationDate()
Property<GregorianCalendar>
'cmis:lastModificationDate'
ObjectType getBaseType()
Property<String> 'cmis:baseTypeId'
ObjectType getType()
Property<String> 'cmis:objectTypeId'
BaseTypeId getBaseTypeId()
String getChangeToken()
Property<String> 'cmis:changeToken'
List<Property<?>> getProperties()
<T> Property<T> getProperty(String id)
id
- the property id
null
if the property does not exist
or is not available<T> T getPropertyValue(String id)
id
- the property id
null
if the property does not
exist or is not available<T> List<T> getPropertyMultivalue(String id)
id
- the property id
null
if the property does not
exist or is not availableAllowableActions getAllowableActions()
List<Relationship> getRelationships()
Acl getAcl()
void delete(boolean allVersions)
allVersions
- if this object is a document this parameter defines if just
this version or all versions should be deletedObjectId updateProperties()
setProperty(String, Object)
or
setPropertyMultivalue(String, List)
.
ObjectId updateProperties(Map<String,?> properties)
properties
- the properties to update
ItemIterable<Relationship> getRelationships(boolean includeSubRelationshipTypes, RelationshipDirection relationshipDirection, ObjectType type, OperationContext context)
List<Rendition> getRenditions()
void applyPolicy(ObjectId policyId)
void removePolicy(ObjectId policyId)
List<Policy> getPolicies()
Acl getAcl(boolean onlyBasicPermissions)
Acl applyAcl(List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation)
void addAcl(List<Ace> addAces, AclPropagation aclPropagation)
void removeAcl(List<Ace> removeAces, AclPropagation aclPropagation)
<T> void setProperty(String id, T value)
updateProperties()
to store the new value in the repository.
<T> void setPropertyMultivalue(String id, List<T> value)
updateProperties()
to store the new value in the repository.
List<Object> getExtensions(ExtensionLevel level)
boolean isChanged()
long getRefreshTimestamp()
void refresh()
void refreshIfOld(long durationInMillis)
durationInMillis
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |