com.tsgrp.opencontent.core.content

Interface IContent

All Known Implementing Classes:

AbstractContentImpl, AlfrescoEmbContentImpl, DCTMContentImpl, DynamoContentImpl, ElasticsearchContentImpl, HBaseContentImpl, S3ContentImpl, SolrContentImpl, SolrS3ContentImpl

public interface IContent

This interface provides content access and manipulation methods.

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	addRelation(AddRelationRequest req) Adds a relation between parent document and children.
void	applyAspect(java.lang.String ticket, java.lang.String objectId, java.lang.String aspectType, java.util.Map<java.lang.String,java.lang.Object> mandatoryProperties) Adds an aspect to a document.
java.util.List<ContentResult>	bulkEnhancedCreateObjects(java.lang.String ticket, java.util.List<EnhancedCompleteObject> objects) Attempts to create new enhanced objects in the system, and returns the results.
java.util.List<ContentResult>	bulkEnhancedCreateObjects(java.lang.String ticket, java.util.List<EnhancedCompleteObject> objects, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Attempts to create new enhanced objects in the system, and returns the results.
boolean	cancelCheckout(java.lang.String ticket, java.lang.String objectId) Cancels checkout of document.
ContentResult	checkin(java.lang.String ticket, java.lang.String objectId, boolean keepLock, java.lang.String versionLabels, java.lang.String comment, boolean majorVersion) Deprecated. use checkin(String, String, boolean, String, String, boolean, OpenContentObject, boolean, DataHandler) instead.
ContentResult	checkin(java.lang.String ticket, java.lang.String objectId, boolean keepLock, java.lang.String versionLabels, java.lang.String comment, boolean majorVersion, OpenContentObject object, boolean newVersion, javax.activation.DataHandler dataHandler) Checks in a node to the repository.
ContentResult	checkin(java.lang.String ticket, java.lang.String objectId, boolean keepLock, java.lang.String versionLabels, java.lang.String comment, boolean majorVersion, OpenContentObject object, boolean newVersion, java.lang.Long size, javax.activation.DataHandler dataHandler) Checks in a node to the repository.
boolean	checkout(java.lang.String ticket, java.lang.String objectId) Checks out a document.
ContentResult	copyDocument(java.lang.String ticket, java.lang.String id, java.lang.String copyName) Returns objectId for the given copied document only, no content returned.
java.lang.String	createObject(java.lang.String ticket, CompleteObject object) Imports document content and properties to the repository.
boolean	deleteObjects(java.lang.String ticket, java.lang.String[] objectIds, boolean allVersions) Deletes objects in the content store.
ContentResult	enhancedCreateObject(java.lang.String ticket, EnhancedCompleteObject object) Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties
ContentResult	enhancedCreateObject(java.lang.String ticket, EnhancedCompleteObject object, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties
ContentResult	enhancedDeleteObject(java.lang.String ticket, java.lang.String id, boolean allVersions, boolean forceDelete) Retrieves document content and properties
ContentResult	enhancedDeleteObject(java.lang.String ticket, java.lang.String id, boolean allVersions, boolean forceDelete, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Delete the object specified by id
ContentResult	enhancedGetObject(java.lang.String ticket, java.lang.String id, java.lang.String[] fileExntesionArr) Retrieves document content and properties.
ContentResult	enhancedGetObjectByPath(java.lang.String ticket, java.lang.String path, java.lang.String[] fileExtensionArr) Deprecated. - Use getObjectByPath instead. Obtain object by passing its path WARNING: This method opens an InputStream. You must close this in the calling method.
ContentResult	enhancedGetPathByFolderId(java.lang.String ticket, java.lang.String objectId) Obtain folder path by passing in folder ID
ContentResult	enhancedGetProperties(java.lang.String ticket, java.lang.String id) Returns metadata for the given id only, no content returned.
ContentResult	enhancedUpdateObject(java.lang.String ticket, java.lang.String id, EnhancedCompleteObject object, boolean newVersion, boolean majorVersion) Updates existing document object in the repository.
ContentResult	enhancedUpdateObject(java.lang.String ticket, java.lang.String id, EnhancedCompleteObject object, boolean newVersion, boolean majorVersion, java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams) Updates existing document object in the repository.
java.net.URL	generatePresignedUrl(java.lang.String ticket, java.lang.String objectId, java.lang.String[] fileExtensions, boolean download, boolean inline) Returns a presigned url to requested content
java.util.List<java.lang.String>	getAppliedAspects(java.lang.String ticket, java.lang.String objectId) Retrieves a list of aspects applied to the provided objectId.
ObjectContent	getContent(GetContentRequest request) Deprecated. use enhancedGetObject(String, String, String[]) instead
UserResult	getLockOwner(java.lang.String ticket, java.lang.String objectId) Returns a UserResult.
OpenContentObject	getObject(java.lang.String ticket, java.lang.String id) Obtain object by passing its unique id
OpenContentObject	getObjectByPath(java.lang.String ticket, java.lang.String path) Obtain object by passing its path WARNING: This method opens an InputStream.
OpenContentObject	getObjectByPath(java.lang.String ticket, java.lang.String path, boolean quietMode) Obtain object by passing its path This accepts a 'quietMode' parameter that will not throw an error if the object doesn't exist at that path.
ContentResult	getObjectByVersion(java.lang.String ticket, java.lang.String id, java.lang.String versionLabel, java.lang.String[] fileExtensionArr) Obtain object for a specific version
int	getPermissionsRequest(java.lang.String ticket, java.lang.String objectId) Retrieves permissions set on document.
java.util.ArrayList<java.lang.String>	link(java.lang.String ticket, java.lang.String objectId, java.lang.String[] unLinkFrom, java.lang.String[] linkTo) Creates a link request between document and folders.
java.lang.String	lockDocument(java.lang.String ticket, java.lang.String objectId) Locks a document.
void	moveObject(java.lang.String ticket, java.lang.String objectId, java.lang.String parentPathOrId) Moves an object in the repository from one folder to another.
ContentResult	removeRelation(java.lang.String ticket, java.lang.String parentObjectId, java.lang.String[] childIds, java.lang.String relationName) Removes the relationship between the parentId and the childIds passed in of the relation type passed in
java.lang.String	unlockDocument(java.lang.String ticket, java.lang.String objectId) Unlocks out a document.
OpenContentObject	updateObject(java.lang.String ticket, OpenContentObject oco) Updates the object with the same ID as the id provided on the new object.
java.lang.String	updateObject(java.lang.String ticket, java.lang.String objectId, CompleteObject object, boolean newVersion, boolean majorVersion) Updates existing document object in the repository.
OpenContentObject[]	updateObjects(java.lang.String ticket, OpenContentObject[] ocos) Updates the objects with the same IDs as provided objects.

Method Detail

getContent

@Deprecated
ObjectContent getContent(GetContentRequest request)

Deprecated. use enhancedGetObject(String, String, String[]) instead

Retrieves the content of a repository object. Note that if you do not set the content type using GetContentRequest.setFileExtension(String[]) this method will attempt to return the PDF rendition first, and then the native content if a PDF rendition does not exist. Note - when using this method, the InputStream contained within ObjectContent.getContent() must be closed after use.

Parameters:

request - a GetContentRequest object

Returns:

ObjectContent - the content of the object

createObject

java.lang.String createObject(java.lang.String ticket,
                              CompleteObject object)

Imports document content and properties to the repository. WARNING: This method opens an InputStream. You must close this in the calling method.

Parameters:

ticket - an authentication ticket

object - a CompleteObject obj

Returns:

the object ID of the newly created object

updateObject

java.lang.String updateObject(java.lang.String ticket,
                              java.lang.String objectId,
                              CompleteObject object,
                              boolean newVersion,
                              boolean majorVersion)

Updates existing document object in the repository.

Parameters:

ticket - an authentication ticket

objectId - the identifier for the document to update

object - a CompleteObject obj

newVersion - true to version or overwrite the existing object, otherwise false

majorVersion - true to increment the version to a new major version, otherwise false

transformMimeType -

Returns:

the object id of the updated or newly-versioned object

deleteObjects

boolean deleteObjects(java.lang.String ticket,
                      java.lang.String[] objectIds,
                      boolean allVersions)

Deletes objects in the content store.

Parameters:

ticket - an authentication ticket

objectIds - a list of object identifiers to delete

allVersions - if true, deletes all versions

Returns:

true if deletion of all objects was successful, otherwise false

getPermissionsRequest

int getPermissionsRequest(java.lang.String ticket,
                          java.lang.String objectId)

Retrieves permissions set on document.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

the permission on the object

cancelCheckout

boolean cancelCheckout(java.lang.String ticket,
                       java.lang.String objectId)

Cancels checkout of document.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

true if the operation was successful, otherwise false. Note that this method returns true if the object is not locked.

checkout

boolean checkout(java.lang.String ticket,
                 java.lang.String objectId)

Checks out a document.

Parameters:

ticket - an authentication ticket

objectId - the identifier used to locate a document

Returns:

true if the checkout occurred successfully, otherwise false. Note, if the object is already checked out, this method will return false.

lockDocument

java.lang.String lockDocument(java.lang.String ticket,
                              java.lang.String objectId)

Locks a document.

Parameters:

ticket -

objectId -

Returns:

String

null if the document is already locked.

unlockDocument

java.lang.String unlockDocument(java.lang.String ticket,
                                java.lang.String objectId)

Unlocks out a document.

Parameters:

ticket -

objectId -

Returns:

String

null if the document is already locked.

getLockOwner

UserResult getLockOwner(java.lang.String ticket,
                        java.lang.String objectId)

Returns a UserResult. If the document is locked the UserBean[] will be populated with the UserBean of the locking User, otherwise, the UserBean[] field will be null.

Parameters:

ticket -

objectId -

Returns:

UserResult

• UserResult.getError() - True if there is an error
• UserResult.getErrorDetails() - Details about the error
• UserResult.getUserBeans() - If the document is locked, an array of length 1, containing the userbean of the locking user or null of there is no lock.

checkin

ContentResult checkin(java.lang.String ticket,
                      java.lang.String objectId,
                      boolean keepLock,
                      java.lang.String versionLabels,
                      java.lang.String comment,
                      boolean majorVersion,
                      OpenContentObject object,
                      boolean newVersion,
                      javax.activation.DataHandler dataHandler)

Checks in a node to the repository. This may fail on implementations that require size (e.g. Dynamo). Use the overloaded checkin for implementations that require size.

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the object to check in.

keepLock - whether to keep the lock or release it after the checkin is complete.

versionLabels - the version lable of the document that will be checked in.

comment - the comment for checking in the document.

majorVersion - true if the document should become a major version on checkin.

object - the object to use for setting new property values on checkin - NOTE: this is currently not implemented.

newVersion - whether this should be a new version or the same version.

dataHandler - the data handler containing the input stream for the new content of the checked in object.

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId returns ID of the object checked in

checkin

ContentResult checkin(java.lang.String ticket,
                      java.lang.String objectId,
                      boolean keepLock,
                      java.lang.String versionLabels,
                      java.lang.String comment,
                      boolean majorVersion,
                      OpenContentObject object,
                      boolean newVersion,
                      java.lang.Long size,
                      javax.activation.DataHandler dataHandler)

Checks in a node to the repository. Overloaded for impls that require size

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the object to check in.

keepLock - whether to keep the lock or release it after the checkin is complete.

versionLabels - the version lable of the document that will be checked in.

comment - the comment for checking in the document.

majorVersion - true if the document should become a major version on checkin.

object - the object to use for setting new property values on checkin - NOTE: this is currently not implemented.

size - the object size in bytes

newVersion - whether this should be a new version or the same version.

dataHandler - the data handler containing the input stream for the new content of the checked in object.

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId returns ID of the object checked in

checkin

@Deprecated
ContentResult checkin(java.lang.String ticket,
                                   java.lang.String objectId,
                                   boolean keepLock,
                                   java.lang.String versionLabels,
                                   java.lang.String comment,
                                   boolean majorVersion)

Deprecated. use checkin(String, String, boolean, String, String, boolean, OpenContentObject, boolean, DataHandler) instead.

Checks in a node to the repository.

Parameters:

ticket - a valid OC ticket.

objectId - the objectId of the object to check in.

keepLock - whether to keep the lock or release it after the checkin is complete.

versionLabels - the version lable of the document that will be checked in.

comment - the comment for checking in the document.

majorVersion - true if the document should become a major version on checkin.

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId returns ID of the object checked in

addRelation

java.lang.String[] addRelation(AddRelationRequest req)

Adds a relation between parent document and children.

Parameters:

req - an AddRelationRequest object

Returns:

an array of IDs of relation objects added by this method

removeRelation

ContentResult removeRelation(java.lang.String ticket,
                             java.lang.String parentObjectId,
                             java.lang.String[] childIds,
                             java.lang.String relationName)

Removes the relationship between the parentId and the childIds passed in of the relation type passed in

Parameters:

ticket - An authentication ticket

parentObjectId - ID of the parent object to remove the rendition relation from

childIds - An array of child IDs to remove from relation

relationName - - name of parent-child relation to remove

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• result set to parentId if the remove succeeded, null if it failed

No content is brought back on the EnhancedCompleteObjects representing our versions

link

java.util.ArrayList<java.lang.String> link(java.lang.String ticket,
                                           java.lang.String objectId,
                                           java.lang.String[] unLinkFrom,
                                           java.lang.String[] linkTo)

Creates a link request between document and folders.

Parameters:

ticket - String representing the session's ticket

objectId - ID of the object that is to be linked

unLinkFrom - String[] representing the folders that the object will be unlinked from

linkTo - String[] representing the folders that the object will be linked to

Returns:

A of folder IDs that objectId was linked to

enhancedCreateObject

ContentResult enhancedCreateObject(java.lang.String ticket,
                                   EnhancedCompleteObject object)

Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties

Parameters:

ticket - String representing the session's ticket

object - EnhancedCompleteObject object to create in the system

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

enhancedCreateObject

ContentResult enhancedCreateObject(java.lang.String ticket,
                                   EnhancedCompleteObject object,
                                   java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Attempts to create a new enhanced object in the system, and returns the result expects an objectName property to be set in the object's properties

Parameters:

ticket - String representing the session's ticket

object - EnhancedCompleteObject object to create in the system

additionalEventParams - HashMap additional params to pass through to OCEvents (i.e filter properties or for injection)

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

bulkEnhancedCreateObjects

java.util.List<ContentResult> bulkEnhancedCreateObjects(java.lang.String ticket,
                                                        java.util.List<EnhancedCompleteObject> objects)

Attempts to create new enhanced objects in the system, and returns the results. Expects an objectName property to be set in each object's properties.

Parameters:

ticket - - String representing the session's ticket.

objects - - List of EnhancedCompleteObject objects to create in the system.

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

bulkEnhancedCreateObjects

java.util.List<ContentResult> bulkEnhancedCreateObjects(java.lang.String ticket,
                                                        java.util.List<EnhancedCompleteObject> objects,
                                                        java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Attempts to create new enhanced objects in the system, and returns the results. Expects an objectName property to be set in each object's properties.

Parameters:

ticket - - String representing the session's ticket.

objects - - List of EnhancedCompleteObject objects to create in the system.

additionalEventParams - - HashMap additional params to pass through to OCEvents (i.e filter properties or for injection).

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• objectId object ID of the created object

enhancedDeleteObject

ContentResult enhancedDeleteObject(java.lang.String ticket,
                                   java.lang.String id,
                                   boolean allVersions,
                                   boolean forceDelete)

Retrieves document content and properties

Parameters:

ticket - String representing the session's ticket

id - ID of the object to get

fileExntesionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

additionalParams - HashMap additional params to pass through to OCEvents

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• object contains the Object we are trying to get

enhancedDeleteObject

ContentResult enhancedDeleteObject(java.lang.String ticket,
                                   java.lang.String id,
                                   boolean allVersions,
                                   boolean forceDelete,
                                   java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Delete the object specified by id

Parameters:

ticket - String representing the session's ticket

id - ID of the object to delete

allVersions - true to delete all versions of the object defined by id, otherwise false

forceDelete - currently only implemented for Alfresco, otherwise false

additionalEventParams - HashMap additional params to pass through to OCEvents (i.e filter properties or for injection)

Returns:

• ContentResult
• error returns true if method failed, otherwise false

enhancedGetObject

ContentResult enhancedGetObject(java.lang.String ticket,
                                java.lang.String id,
                                java.lang.String[] fileExntesionArr)

Retrieves document content and properties. If you only need properties, use enhancedGetProperties(String, String) instead. Note that since this method gets both content and properties, calling code must close the ContentResult with OCUtil.closeQuietly(ContentResult).

Parameters:

ticket - String representing the session's ticket

id - ID of the object to get

fileExntesionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

additionalParams - HashMap additional params to pass through to OCEvents

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• object contains the Object we are trying to get

See Also:

enhancedGetProperties(String, String), OCUtil.closeQuietly(ContentResult)

enhancedGetProperties

ContentResult enhancedGetProperties(java.lang.String ticket,
                                    java.lang.String id)

Returns metadata for the given id only, no content returned.

Parameters:

ticket - String representing the session's ticket

id - ID of the object to get properties from

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• object
• objectType - repo specific object type
• props - metadata for object

enhancedUpdateObject

ContentResult enhancedUpdateObject(java.lang.String ticket,
                                   java.lang.String id,
                                   EnhancedCompleteObject object,
                                   boolean newVersion,
                                   boolean majorVersion)

Updates existing document object in the repository. This call does NOT retain the current lock, regardless if a new version is created or not. In other words, if this call is made and there is currently a lock on the document object, it will be released.

Parameters:

ticket - String representing the session's ticket

id - ID of the object to update

object - an EnhancedCompleteObject

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

• ContentResult
• error returns true if update failed, otherwise false
• result contains number of rows updated

enhancedUpdateObject

ContentResult enhancedUpdateObject(java.lang.String ticket,
                                   java.lang.String id,
                                   EnhancedCompleteObject object,
                                   boolean newVersion,
                                   boolean majorVersion,
                                   java.util.HashMap<java.lang.String,java.lang.Object> additionalEventParams)

Updates existing document object in the repository. This call does NOT retain the current lock, regardless if a new version is created or not. In other words, if this call is made and there is currently a lock on the document object, it will be released.

Parameters:

ticket - String representing the session's ticket

id - ID of the object to update

object - an EnhancedCompleteObject

newVersion - true if the update will be saved to a new version, otherwise false.

majorVersion - true if the update will be saved to a major version, otherwise false.

Returns:

• ContentResult
• error returns true if update failed, otherwise false
• result contains number of rows updated

enhancedGetObjectByPath

@Deprecated
ContentResult enhancedGetObjectByPath(java.lang.String ticket,
                                                   java.lang.String path,
                                                   java.lang.String[] fileExtensionArr)

Deprecated. - Use getObjectByPath instead. Obtain object by passing its path WARNING: This method opens an InputStream. You must close this in the calling method.

Parameters:

ticket - String representing the session's ticket

path - path to the object to get

fileExtensionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• object contains the Object we are trying to get

getObjectByPath

OpenContentObject getObjectByPath(java.lang.String ticket,
                                  java.lang.String path)

Obtain object by passing its path WARNING: This method opens an InputStream. You must close this in the calling method.

Parameters:

ticket - String representing the session's ticket

path - path to the object to get

Returns:

OpenContentObject

getObjectByPath

OpenContentObject getObjectByPath(java.lang.String ticket,
                                  java.lang.String path,
                                  boolean quietMode)

Obtain object by passing its path This accepts a 'quietMode' parameter that will not throw an error if the object doesn't exist at that path. In certain scenarios, a majority of the time the object won't be there, so we don't want to pollute the logs with stacktraces and/or errors.

Parameters:

ticket - sessions ticket

path - path to the object to het

quietMode - If true, we will not throw an error if the object doesn't exist

Returns:

if object exists and the user has access, the OCO will be returned. if not and if quietMode is TRUE, it will return null and if quietMode is FALSE, it will throw an error

getObject

OpenContentObject getObject(java.lang.String ticket,
                            java.lang.String id)

Obtain object by passing its unique id

Parameters:

ticket - String representing the session's ticket

path - Unique id of the object in the repository

Returns:

OpenContentObject

enhancedGetPathByFolderId

ContentResult enhancedGetPathByFolderId(java.lang.String ticket,
                                        java.lang.String objectId)

Obtain folder path by passing in folder ID

Parameters:

ticket - String representing the session's ticket

objectId - id of the folder to get path from

Returns:

• ContentResult
• error returns true if method failed, otherwise false
• ContentResult.result contains the folder path we are trying to get

getObjectByVersion

ContentResult getObjectByVersion(java.lang.String ticket,
                                 java.lang.String id,
                                 java.lang.String versionLabel,
                                 java.lang.String[] fileExtensionArr)

Obtain object for a specific version

Parameters:

ticket - String representing the session's ticket

id - id of the object we are trying to get

versionLabel - version of the object we are trying to get

fileExtensionArr - An array of content types. By default, this array consists of {"pdf", ".*"}, which indicates PDF is preferred, then fall back to the native content.

Returns:

• ContentResult
• error returns true if get object by version failed, otherwise false
• object contains the Object we are trying to get

copyDocument

ContentResult copyDocument(java.lang.String ticket,
                           java.lang.String id,
                           java.lang.String copyName)

Returns objectId for the given copied document only, no content returned.

Parameters:

ticket - String representing the session's ticket

id - id of the object we want to make a copy of

copyName - name of the newly copied object. If set to null or "", the name of the new object will be "Copy of ${original object's name}".

Returns:

• ContentResult
• error returns true if get object by version failed, otherwise false
• object contains the newly copied object

updateObject

OpenContentObject updateObject(java.lang.String ticket,
                               OpenContentObject oco)

Updates the object with the same ID as the id provided on the new object. Note: This method 'replaces' the object the repo with the object you provide. Any properties on the repo object that are NOT on the supplied object will be removed/nulled out. Will attempt to update objectType, aspects, and properties. Note that this does not version or check in.

Parameters:

ticket -

oco - - The modified Object

Returns:

- The new OCO

Throws:

java.lang.UnsupportedOperationException - if the underlying implementation does not support update of objectType, aspect, or properties and an update was provided.

updateObjects

OpenContentObject[] updateObjects(java.lang.String ticket,
                                  OpenContentObject[] ocos)

Updates the objects with the same IDs as provided objects. Note: This method 'replaces' the object the repo with the object you provide. Any properties on the repo object that are NOT on the supplied object will be removed/nulled out. Will attempt to update objectType, aspects, and properties. Note that this does not version or check in.

Parameters:

ticket -

ocos - - The objects to update

Returns:

- The updated objects

Throws:

java.lang.UnsupportedOperationException - if the underlying implementation does not support update of objectType, aspect, or properties and an update was provided.

getAppliedAspects

java.util.List<java.lang.String> getAppliedAspects(java.lang.String ticket,
                                                   java.lang.String objectId)

Retrieves a list of aspects applied to the provided objectId. Note: For obvious reasons, this method will only produce results on an Alfresco backend. For other filesystems, will return an empty list of strings.

Parameters:

ticket -

objectId -

Returns:

A list of aspects applied to the given objectId in bean format eg, tsg_rendition

applyAspect

void applyAspect(java.lang.String ticket,
                 java.lang.String objectId,
                 java.lang.String aspectType,
                 java.util.Map<java.lang.String,java.lang.Object> mandatoryProperties)

Adds an aspect to a document. Note: This will throw an error if called from a non Alfresco backend.

Parameters:

ticket - a valid OC ticket

objectId - the object the aspect will be applied to

aspectType - the type of aspect to be added (in OCName format)

mandatoryProperties - a list of properties that are mandatory for the aspect (in OCName format). Set to null/empty map for no properties

moveObject

void moveObject(java.lang.String ticket,
                java.lang.String objectId,
                java.lang.String parentPathOrId)

Moves an object in the repository from one folder to another.

Parameters:

ticket - a valid OC ticket.

objectId - the ID of the object to move to a new folder.

parentPathOrId - the path or ID of the folder to move the new object to.

generatePresignedUrl

java.net.URL generatePresignedUrl(java.lang.String ticket,
                                  java.lang.String objectId,
                                  java.lang.String[] fileExtensions,
                                  boolean download,
                                  boolean inline)

Returns a presigned url to requested content

Parameters:

ticket -

objectId -

download - - if set to true, will set the content-disposition header to 'attachment' so signal download

inline - - if set to true, will set the content-disposition header to 'inline' so that files are shown inline

Returns:

presigned url