public interface StoredObject
Modifier and Type | Method and Description |
---|---|
void |
addAppliedPolicy(String policyId)
add an id of a policy to an object
|
void |
createSystemBasePropertiesWhenCreated(Map<String,PropertyData<?>> properties,
String user)
Create all system base properties that need to be stored with every
object in the repository This method is called when a new object is
created to record all of the capturing data like the creation time,
creator etc.
|
void |
fillProperties(Map<String,PropertyData<?>> properties,
BindingsObjectFactory objFactory,
List<String> requestedIds) |
int |
getAclId()
get the Acl id of the stored object
|
AllowableActions |
getAllowableActions(String user) |
List<String> |
getAppliedPolicies()
get applied policies of this object
|
String |
getChangeToken()
Retrieve a change token uniquely identifying the state of the object when
it was persisted (used for optimistic locking)
|
GregorianCalendar |
getCreatedAt() |
String |
getCreatedBy()
Retrieve the user who created the document
|
String |
getDescription()
CMIS 1.1: get description of an object
|
String |
getId()
Retrieve the id of this object.
|
GregorianCalendar |
getModifiedAt()
Retrieve date and time when the object was last modified.
|
String |
getModifiedBy()
Retrieve the user who last modified the document
|
String |
getName()
Retrieve the name of this object
|
Map<String,PropertyData<?>> |
getProperties()
Retrieve the list of properties
|
ContentStream |
getRenditionContent(String streamId,
long offset,
long length)
get the rendition of this object
|
List<RenditionData> |
getRenditions(String renditionFilter,
long maxItems,
long skipCount)
get the rendition this objects supports
|
String |
getRepositoryId()
Get the repository id of this object where the object is stored.
|
List<String> |
getSecondaryTypeIds()
CMIS 1.1 get ids of all secondary types
|
String |
getTypeId()
Retrieve the type of this document.
|
boolean |
hasRendition(String user)
check if the document can generate a renditions and rendition is visible for user
|
void |
removePolicy(String policyId)
remove an id of a policy from an object
|
void |
setCreatedAt(GregorianCalendar createdAt)
Assign date and time when the object was created.
|
void |
setCreatedBy(String createdBy)
Set the user who last modified the object.
|
void |
setCustomProperties(Map<String,PropertyData<?>> properties)
Set all properties which are not system properties.
|
void |
setDescription(String description)
CMIS 1.1: set description of an object
|
void |
setId(String id)
Set the id of this object
|
void |
setModifiedAt(GregorianCalendar calendar)
Set the date and time of the last modification of this object
|
void |
setModifiedAtNow()
Assign current date and time when the object was last modified.
|
void |
setModifiedBy(String modifiedBy)
Set the user who last modified the object.
|
void |
setName(String name)
Set the name of this document.
|
void |
setProperties(Map<String,PropertyData<?>> props)
Assign the properties to an object.
|
void |
setRepositoryId(String repositoryId)
Assign a repository where this object will be stored.
|
void |
setTypeId(String type)
Set the type of this document.
|
void |
updateSystemBasePropertiesWhenModified(Map<String,PropertyData<?>> properties,
String user)
Update all system base properties that need to be stored with every
object in the repository This method is called when an object is is
updated to record all of the capturing data like the modification time,
updating user etc.
|
String getId()
void setId(String id)
id
- id of this objectString getName()
void setName(String name)
name
- name that is assigned to this objectString getTypeId()
void setTypeId(String type)
type
- id of the type this object gets assigned.List<String> getSecondaryTypeIds()
void setDescription(String description)
description
- description of this objectString getDescription()
String getCreatedBy()
void setCreatedBy(String createdBy)
createdBy
- user who last modified the documentString getModifiedBy()
void setModifiedBy(String modifiedBy)
modifiedBy
- user who last modified the documentGregorianCalendar getCreatedAt()
void setCreatedAt(GregorianCalendar createdAt)
createdAt
- date the object was createdGregorianCalendar getModifiedAt()
void setModifiedAtNow()
void setModifiedAt(GregorianCalendar calendar)
calendar
- timestamp of last modificationString getRepositoryId()
void setRepositoryId(String repositoryId)
repositoryId
- id of the repositoryMap<String,PropertyData<?>> getProperties()
void setProperties(Map<String,PropertyData<?>> props)
props
- properties to be assignedString getChangeToken()
void createSystemBasePropertiesWhenCreated(Map<String,PropertyData<?>> properties, String user)
properties
- The properties passed by the client, containing, name, type,
etcuser
- The user creating the documentvoid updateSystemBasePropertiesWhenModified(Map<String,PropertyData<?>> properties, String user)
properties
- The properties passed by the client, containing, name, type,
etcuser
- The user creating the documentvoid fillProperties(Map<String,PropertyData<?>> properties, BindingsObjectFactory objFactory, List<String> requestedIds)
void setCustomProperties(Map<String,PropertyData<?>> properties)
properties
- Set of properties as set by the client, including system
parametersint getAclId()
AllowableActions getAllowableActions(String user)
boolean hasRendition(String user)
List<RenditionData> getRenditions(String renditionFilter, long maxItems, long skipCount)
renditionFilter
- maxItems
- skipCount
- extension
- ContentStream getRenditionContent(String streamId, long offset, long length)
streamId
- stream if of renditionoffset
- offset in rendition contentlength
- length of rendition contentList<String> getAppliedPolicies()
void addAppliedPolicy(String policyId)
policyId
- id of policy to addvoid removePolicy(String policyId)
policyId
- id of policy to removeCopyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.