com.tsgrp.opencontent.core.extendedcontent

Interface IExtendedContent

All Known Implementing Classes:

AlfrescoEmbExtendedContentImpl, DCTMExtendedContentImpl, DynamoExtendedContentImpl, ElasticsearchExtendedContentImpl, HBaseExtendedContentImpl, S3ExtendedContentImpl, SolrExtendedContentImpl

public interface IExtendedContent

More methods for interacting with content in a repository.

Method Summary

Modifier and Type	Method and Description
ExtendedContentResult	addRendition(java.lang.String ticket, java.lang.String objectId, EnhancedObjectContent rendition) Deprecated. Use IRendition instead
void	changeType(java.lang.String ticket, java.lang.String objectId, java.lang.String newType) Changes the type of an object NOTE: May not be able to change type as will.
java.lang.String	copyObject(java.lang.String ticket, java.lang.String objectId, java.lang.String destFolderPath) Copy a given object with specified ID to a specified folder path.
java.lang.String	findCurrentVersionId(java.lang.String ticket, java.lang.String chronId) Given a chronId, find the CURRENT version of the object and return its objectId
java.lang.String	findFirstVersionId(java.lang.String ticket, java.lang.String objectId) Given an objectId, find the first version of the object
java.lang.String	findLatestVersionId(java.lang.String ticket, java.lang.String chronId) Given a chronId, find the LATEST version of the object and return its objectId
java.lang.String	getAcl(java.lang.String ticket, java.lang.String objectId) Return the object ID of the ACL for a given document ID.
java.lang.String	getAclName(java.lang.String ticket, java.lang.String objectId) Return the name of the ACL for a given document ID.
ExtendedContentResult	getAllSubtypes(java.lang.String ticket, java.lang.String parentTypeName) Returns the object type and all of its subtypes within the repository.
ExtendedContentResult	getAllVersions(java.lang.String ticket, java.lang.String objectId) Returns all versions of an object
java.util.Map<java.lang.String,java.lang.String>	getAvailableThumbnails(java.lang.String ticket, java.lang.String objectId, java.lang.String def) Get a list of available thumbnails for a content item (meaning thumbnails that have been generated)
ExtendedContentResult	getChildByName(java.lang.String ticket, java.lang.String parentId, java.lang.String objectName) Deprecated.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	getChildFolders(java.lang.String ticket, java.lang.String id) Returns all children folders contained in the given object, only returns direct children.
ExtendedContentResult	getChildren(java.lang.String ticket, java.lang.String objectId) Deprecated.
java.util.List<OpenContentObject>	getChildren(java.lang.String ticket, java.lang.String objectId, java.lang.String[] mimetypeFilters) Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied.
java.util.List<OpenContentObject>	getChildren(java.lang.String ticket, java.lang.String objectId, java.lang.String[] mimetypeFilters, java.lang.Boolean includeRenditionable) Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied.
ObjectContentInfo	getContentInfo(java.lang.String ticket, java.lang.String objectId) Returns the ObjectContentInfo object for the given object.
java.lang.String	getContentPath(java.lang.String objectId, java.lang.String contentType) Returns the full filepath of the document's content.
ExtendedContentResult	getObjectPath(java.lang.String ticket, java.lang.String objectId) Returns the path to given objectId
ExtendedContentResult	getParents(java.lang.String ticket, java.lang.String objectId) Returns all the parents of the passed in objectId
ExtendedContentResult	getRelatedChildren(java.lang.String ticket, java.lang.String objectId, java.lang.String relationName) Returns all the children of the passed in objectId with the passed in relation
ExtendedContentResult	getRelatedParents(java.lang.String ticket, java.lang.String objectId, java.lang.String relationName) Returns all the parents of the passed in objectId with the passed in relation
EnhancedObjectContent	getThumbnail(java.lang.String ticket, java.lang.String objectId, java.lang.String thumbnailName) Get a thumbnail of a given object that is represented by a thumbnail name (e.g.
java.lang.String	getUUID(java.lang.String ticket, java.lang.String objectId) Given an object id, return the unique identifier for that object.
boolean	hasRelations(java.lang.String ticket, java.lang.String objectId, java.lang.String relationName, boolean parent) Returns true if an object with objectId has either a parent or child relationship of relationName.
boolean	isContainer(java.lang.String ticket, java.lang.String objectId) Return whether or not the object related to the ticket is a container or not
ExtendedContentResult	removeRendition(java.lang.String ticket, java.lang.String objectId, java.lang.String mimeType) Deprecated. Use IRendition instead
java.lang.String	resolveVersion(java.lang.String ticket, java.lang.String objectId, java.lang.String label) Given an objectId (not necessarily the version we are looking for) find the version of the document that is labeled with the label that is passed in.
boolean	setAcl(java.lang.String ticket, java.lang.String aclId, java.lang.String objectId) Set the ACL for a given document.

Method Detail

copyObject

java.lang.String copyObject(java.lang.String ticket,
                            java.lang.String objectId,
                            java.lang.String destFolderPath)

Copy a given object with specified ID to a specified folder path.

Parameters:

ticket - an authentication ticket

objectId - the object ID to create a copy of

destFolderPath - location to copy the object to

Returns:

the object ID of the newly created object, or null on failure

getAcl

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

Return the object ID of the ACL for a given document ID.

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to get the ACL for

Returns:

the object ID of the ACL attached to the specified document

getAclName

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

Return the name of the ACL for a given document ID.

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to get the ACL for

Returns:

the name of the ACL attached to the specified document

setAcl

boolean setAcl(java.lang.String ticket,
               java.lang.String aclId,
               java.lang.String objectId)

Set the ACL for a given document.

Parameters:

ticket - an authentication ticket

aclId - the object ID of the ACL to apply to the document

objectId - the object ID of the document to apply the ACL to

Returns:

whether the ACL setting was successful

getChildren

@Deprecated
ExtendedContentResult getChildren(java.lang.String ticket,
                                               java.lang.String objectId)

Deprecated.

Returns all children objects (documents/folders) contained in the given object, only returns direct children.

Parameters:

ticket -

objectId -

Returns:

• ExtendedContentResult
• objects - one object for each child
• objectType - repo specific object type
• props - metadata for object

getChildren

java.util.List<OpenContentObject> getChildren(java.lang.String ticket,
                                              java.lang.String objectId,
                                              java.lang.String[] mimetypeFilters,
                                              java.lang.Boolean includeRenditionable)

Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied.

Parameters:

ticket -

objectId -

mimetypeFilters -

includeRenditionable - optional parameter to allow documents which don't but can match filters

Returns:

• ExtendedContentResult
• objects - one object for each child
• objectType - repo specific object type
• props - metadata for object

getChildren

java.util.List<OpenContentObject> getChildren(java.lang.String ticket,
                                              java.lang.String objectId,
                                              java.lang.String[] mimetypeFilters)

Returns all children objects (documents/folders) contained in the given object, only returns direct children and those that match the mimetype supplied. getChildren(String, String, String[], Boolean) is called and defaults includeRenditionable to false.

Parameters:

ticket -

objectId -

mimetypeFilters -

Returns:

• ExtendedContentResult
• objects - one object for each child
• objectType - repo specific object type
• props - metadata for object

getChildFolders

java.util.List<java.util.Map<java.lang.String,java.lang.String>> getChildFolders(java.lang.String ticket,
                                                                                 java.lang.String id)

Returns all children folders contained in the given object, only returns direct children.

Parameters:

ticket -

objectId -

Returns:

list of child folders containing only the folder Id and folder name (map keys: objectId, objectName)

getContentInfo

ObjectContentInfo getContentInfo(java.lang.String ticket,
                                 java.lang.String objectId)

Returns the ObjectContentInfo object for the given object. NOTE: This method will not return any content, only info on the formats. Thumbnail content will NOT be returned. Only content formats that are known in the mimeType-extension map will be returned. If the object has more than one format, index 0 on the lists on the ObjectContentInfo will be the native content property, while the 2nd-N items will contain renditions.

Parameters:

ticket - Authentication ticket

objectId - Object Id of the object whose content info is to be retrieved

Returns:

a ObjectContentInfo object with info on the known formats of the object

getAllVersions

ExtendedContentResult getAllVersions(java.lang.String ticket,
                                     java.lang.String objectId)

Returns all versions of an object

Parameters:

ticket -

objectId -

Returns:

in order from most recent to oldest. ExtendedContentResult.objects[0] is current version

• ExtendedContentResult
• objects - one object for each version
• objectType - repo specific object type
• props - metadata for object

No content is brought back on the EnhancedCompleteObjects representing our versions

addRendition

@Deprecated
ExtendedContentResult addRendition(java.lang.String ticket,
                                                java.lang.String objectId,
                                                EnhancedObjectContent rendition)

Deprecated. Use IRendition instead

Adds a rendition to a document. The rendition. This method will delete renditions that already exist of the same mimeType as the new rendition being created. It then will create and add the new rendition.

Parameters:

ticket -

objectId -

rendition - the content and the mimetype of the rendition

Returns:

• ExtendedContentResult
• boolean Error, true if addRendition failed, false if successful

getParents

ExtendedContentResult getParents(java.lang.String ticket,
                                 java.lang.String objectId)

Returns all the parents of the passed in objectId

Parameters:

ticket -

objectId -

Returns:

• ExtendedContentResult
• objects - one object for each parent
• objectType - repo specific object type
• props - metadata for object

getAllSubtypes

ExtendedContentResult getAllSubtypes(java.lang.String ticket,
                                     java.lang.String parentTypeName)

Returns the object type and all of its subtypes within the repository. NOTE: The type passed in is INCLUDED in the return objects.

Parameters:

ticket - Authentication ticket

parentTypeName - name of the parent type

Returns:

• ExtendedContentResult
• objects - one object for object type
• objectType - repo specific object type

No content is brought back on the EnhancedCompleteObjects representing our versions

getRelatedParents

ExtendedContentResult getRelatedParents(java.lang.String ticket,
                                        java.lang.String objectId,
                                        java.lang.String relationName)

Returns all the parents of the passed in objectId with the passed in relation

Parameters:

ticket -

objectId -

Returns:

• ExtendedContentResult
• objects - one object for each parent
• objectType - repo specific object type
• props - metadata for object

getRelatedChildren

ExtendedContentResult getRelatedChildren(java.lang.String ticket,
                                         java.lang.String objectId,
                                         java.lang.String relationName)

Returns all the children of the passed in objectId with the passed in relation

Parameters:

ticket -

objectId -

Returns:

• ExtendedContentResult
• objects - one object for each child (NOTE: the content of each child should NOT be populated)
• objectType - repo specific object type
• props - metadata for object

getObjectPath

ExtendedContentResult getObjectPath(java.lang.String ticket,
                                    java.lang.String objectId)

Returns the path to given objectId

Parameters:

ticket - - session ticket

objectId - - objectId of a document or folder. (DCTM implementation doesn't support documents and will throw an error)

Returns:

the full path including the folder name, of the passed in objectId. ex. "/Wizard/Wizard/myPSIFolder" when given a folderId or "/Wizard/Wizard/myPSIFolder/mypsi.xml" when given a documentId (documents are only supported in Alfresco)

• ExtendedContentResult
• stringResult - repository folder path to the given object

removeRendition

@Deprecated
ExtendedContentResult removeRendition(java.lang.String ticket,
                                                   java.lang.String objectId,
                                                   java.lang.String mimeType)

Deprecated. Use IRendition instead

Remove a rendition of a document. Returns the stringResult attribute populated with the mimeType if the rendition was successfully removed. Returns a blank stringResult if the rendition was not removed.

Parameters:

ticket -

objectId -

mimeType -

Returns:

• ExtendedContentResult
• stringResult - mimeType of the rendition that was sucessfully removed

getAvailableThumbnails

java.util.Map<java.lang.String,java.lang.String> getAvailableThumbnails(java.lang.String ticket,
                                                                        java.lang.String objectId,
                                                                        java.lang.String def)

Get a list of available thumbnails for a content item (meaning thumbnails that have been generated)

Parameters:

ticket -

objectId -

Returns:

• List - Map of available Types

getThumbnail

EnhancedObjectContent getThumbnail(java.lang.String ticket,
                                   java.lang.String objectId,
                                   java.lang.String thumbnailName)

Get a thumbnail of a given object that is represented by a thumbnail name (e.g. 'doclib-small')

Parameters:

ticket -

objectId -

thumbnailName -

Returns:

• Byte[] - Byte Array containing the streamed content of the thumbnail image

resolveVersion

java.lang.String resolveVersion(java.lang.String ticket,
                                java.lang.String objectId,
                                java.lang.String label)

Given an objectId (not necessarily the version we are looking for) find the version of the document that is labeled with the label that is passed in. Implementations will find the given version and return the id of the document that fits the criteria passed in. If the label criteria matches more than one version in the tree, the impl should return the one that was most recently modified.

Parameters:

ticket - an authentication ticket

objectId - any objectId of a document tree to search for a version for

label - the "version label" of the document to search the tree for and return

Returns:

the object ID of the object that matches the given label (blank if no id with criteria is found)

findFirstVersionId

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

Given an objectId, find the first version of the object

Parameters:

ticket - an authentication ticket

objectId - any objectId of a document tree to search for the first version for

Returns:

the first version of the object specified by the objectId parameter, or null if the no objects with the given ID exist

findCurrentVersionId

java.lang.String findCurrentVersionId(java.lang.String ticket,
                                      java.lang.String chronId)

Given a chronId, find the CURRENT version of the object and return its objectId

Parameters:

ticket - an authentication ticket

chronId - any chronId of a document tree to search for the first version for

Returns:

the objectId of the CURRENT version of the doc specified by the chronId parameter

findLatestVersionId

java.lang.String findLatestVersionId(java.lang.String ticket,
                                     java.lang.String chronId)

Given a chronId, find the LATEST version of the object and return its objectId

Parameters:

ticket - an authentication ticket

chronId - any chronId of a document tree to search for the first version for

Returns:

the objectId of the LATEST version of the doc specified by the chronId parameter

hasRelations

boolean hasRelations(java.lang.String ticket,
                     java.lang.String objectId,
                     java.lang.String relationName,
                     boolean parent)

Returns true if an object with objectId has either a parent or child relationship of relationName. Returns false otherwise.

Parameters:

ticket - String of the authentication ticket

objectId - String to represent node's objectId

relationName - String of the relation to find

parent - boolean - if set to true, find parent relationship, else find child relationship

Returns:

True if relationship exists, false otherwise

getUUID

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

Given an object id, return the unique identifier for that object. In most cases, this will just return the objectId. For some impls (read: alfresco), this will strip off unnecessary characters from the objectId.

Parameters:

ticket -

objectId -

Returns:

a String representing the unique identifier for a repo object

getChildByName

@Deprecated
ExtendedContentResult getChildByName(java.lang.String ticket,
                                                  java.lang.String parentId,
                                                  java.lang.String objectName)

Deprecated.

Returns the child(ren) by the given name of the parent ID. If a child or children are found, one EnhancedCompleteObject will be returned for each result, with the OBJECT ID AS THE ONLY PROPERTY. If no child is found, an empty objects array is returned.

Parameters:

ticket -

parentId -

objectName -

Returns:

• ExtendedContentResult
• objects - one object for each child (NOTE: the content of each child should NOT be populated)
• props - metadata for object

isContainer

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

Return whether or not the object related to the ticket is a container or not

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to get the ACL for

Returns:

the object ID of the ACL attached to the specified document

changeType

void changeType(java.lang.String ticket,
                java.lang.String objectId,
                java.lang.String newType)

Changes the type of an object NOTE: May not be able to change type as will. Depends on how type hierarchy works for the specific Impl

Parameters:

ticket - an authentication ticket

objectId - the object ID of a document you wish to change type for

newType - the OCName of the target type

getContentPath

java.lang.String getContentPath(java.lang.String objectId,
                                java.lang.String contentType)

Returns the full filepath of the document's content. Note this is not supported in some implementations. e.g. store://2018/12/12/12/45/b2107d51-6bb3-485c-9874-e700192d38e5.bin ==> 2018/12/12/12/45/b2107d51-6bb3-485c-9874-e700192d38e5.bin