com.adobe.livecycle.contentservices.client
Interface CRCResult

public interface CRCResult

A CRCResult object returns information that is obtained during a Content Services ES2 query operation. Using an object of this type, you can, for example, obtain a PDF document is that retrieved during a query operation. Methods such as retrieveContent return an object of this type. To see this data type used in a code example, see the Retrieve content from Content Services ES2 using the Java API quick start in Programming with LiveCycle ES4.

Method Summary

java.util.Map	getAttributeMap() Returns the names and values of attributes that correspond to the content.
java.lang.String	getBrowseLink() Returns the browse link of the content.
java.lang.String	getContentMimeType() Returns the MIME type of the content.
java.util.Date	getCreationDate() Returns the creation date of the content.
java.lang.String	getCreator() Returns the creator for the content.
Document	getDocument() Returns the document (or other content) that is retrieved from Content Services ES2.
java.lang.String	getFolderPath() Returns the folder path of the content.
java.util.Date	getModificationDate() Returns the date on which the content was last modified.
java.lang.String	getModifier() Returns the name of the Content Services ES2 user who last modified the content.
java.lang.String	getNodeName() Returns the name of the content.
java.lang.String	getNodeType() Returns the node type.
java.lang.String	getNodeUuid() Returns the identifier value that corresponds to the content.
java.lang.String	getQualifiedNodePath() Returns the fully qualified path of the content.
java.lang.String	getStoreName() Returns the name of the store in which the content is located.
java.lang.String	getStoreScheme() Returns the scheme of the store in which content is present.
java.lang.String	getTitle() Returns the title for the content.
java.lang.String	getVersionLabel() Returns the version label of the content.
void	setAttributeMap(java.util.Map attributeMap) For internal use only.
void	setBrowseLink(java.lang.String browseLink) Sets the browse link of the node
void	setContentMimeType(java.lang.String mimeType) For internal use only.
void	setCreationDate(java.util.Date creationDate) For internal use only.
void	setCreator(java.lang.String creator) For internal use only.
void	setDocument(Document document) For internal use only.
void	setFolderPath(java.lang.String folderPath) For internal use only.
void	setModificationDate(java.util.Date modficationDate) For internal use only.
void	setModifier(java.lang.String modifier) For internal use only.
void	setNodeName(java.lang.String nodeName) For internal use only.
void	setNodeType(java.lang.String nodeType) For internal use only.
void	setNodeUuid(java.lang.String nodeUuid) For internal use only.
void	setQualifiedNodePath(java.lang.String qualifiedNodePath) For internal use only.
void	setStoreName(java.lang.String storeName) For internal use only.
void	setStoreScheme(java.lang.String storeScheme) For internal use only.
void	setTitle(java.lang.String title) For internal use only.
void	setVersionLabel(java.lang.String versionLabel) For internal use only.

Method Detail

getDocument

Document getDocument()

Returns the document (or other content) that is retrieved from Content Services ES2. To see this method used in a code example, see the Retrieve content from Content Services ES2 using the Java API quick start in Programming with LiveCycle ES4.

Returns:

A com.adobe.idp.Document object that contains content retrieved from Content Services ES2.

setDocument

void setDocument(Document document)

For internal use only.

getNodeUuid

java.lang.String getNodeUuid()

Returns the identifier value that corresponds to the content. An example of an identifier value is 36f0ab71-44eb-479e-b9c2-9537f2e20ff8.

Returns:

A string value that represents the content.

setNodeUuid

void setNodeUuid(java.lang.String nodeUuid)

For internal use only.

getNodeName

java.lang.String getNodeName()

Returns the name of the content.

Returns:

A string value that represents the content name.

setNodeName

void setNodeName(java.lang.String nodeName)

For internal use only.

getQualifiedNodePath

java.lang.String getQualifiedNodePath()

Returns the fully qualified path of the content. An example of a fully qualified path is /app:company_home/cm:Test_x0020_Directory/cm:MortgageForm.pdf.

Returns:

A string value that represents the fully qualified path of the content.

setQualifiedNodePath

void setQualifiedNodePath(java.lang.String qualifiedNodePath)

For internal use only.

getBrowseLink

java.lang.String getBrowseLink()

Returns the browse link of the content. A browse link is an URL that you can enter into a web browser that brings up the content. An example of a browse link is http://localhost:8080/contentspace/wcs/api/node/content/workspace/SpacesStore/36f0ab71-44eb-479e-b9c2-9537f2e20ff8/MortgageForm.pdf.

Returns:

A string value that specifies the browse link.

setBrowseLink

void setBrowseLink(java.lang.String browseLink)

Sets the browse link of the node

getFolderPath

java.lang.String getFolderPath()

Returns the folder path of the content. An example of a folder path is /Company Home/Test Directory.

Returns:

A string value that specifies the folder path.

setFolderPath

void setFolderPath(java.lang.String folderPath)

For internal use only.

getVersionLabel

java.lang.String getVersionLabel()

Returns the version label of the content.

Returns:

A string value that specifies the version label.

setVersionLabel

void setVersionLabel(java.lang.String versionLabel)

For internal use only.

getNodeType

java.lang.String getNodeType()

Returns the node type. This method returns one of the following values:

• {http://www.alfresco.org/model/content/1.0}content
• {http://www.alfresco.org/model/content/1.0}folder

If the node is content (such as a PDF document), then the first value is returned. If the node is a folder, then the second value is returned.

Returns:

A string value that specifies the node type.

setNodeType

void setNodeType(java.lang.String nodeType)

For internal use only.

getContentMimeType

java.lang.String getContentMimeType()

Returns the MIME type of the content. For example, if the content is a PDF document, then this method returns application/pdf. Likewise, if the content is an XML document, then this method returns text/xml.

Returns:

A string value that specifies the MIME type.

setContentMimeType

void setContentMimeType(java.lang.String mimeType)

For internal use only.

getTitle

java.lang.String getTitle()

Returns the title for the content. If the content does not have a title, then the value untitled is returned.

Returns:

A string value that specifies the title for the content.

setTitle

void setTitle(java.lang.String title)

For internal use only.

getCreator

java.lang.String getCreator()

Returns the creator for the content. An example of a creator is administrator/DefaultDom.

Returns:

A string value that specifies the creator for the content.

setCreator

void setCreator(java.lang.String creator)

For internal use only.

getCreationDate

java.util.Date getCreationDate()

Returns the creation date of the content.

Returns:

A java.util.Date object that represents the date on which the content was created.

setCreationDate

void setCreationDate(java.util.Date creationDate)

For internal use only.

getModifier

java.lang.String getModifier()

Returns the name of the Content Services ES2 user who last modified the content.

Returns:

A string value that specifies the user who last modified the content.

setModifier

void setModifier(java.lang.String modifier)

For internal use only.

getModificationDate

java.util.Date getModificationDate()

Returns the date on which the content was last modified.

Returns:

A java.util.Date object that represents the date on which the content was last modified.

setModificationDate

void setModificationDate(java.util.Date modficationDate)

For internal use only.

getStoreName

java.lang.String getStoreName()

Returns the name of the store in which the content is located.

Returns:

A string value that specifies the store name.

setStoreName

void setStoreName(java.lang.String storeName)

For internal use only.

getStoreScheme

java.lang.String getStoreScheme()

Returns the scheme of the store in which content is present.

Returns:

A string value that specifies the scheme of the store in which content is present.

setStoreScheme

void setStoreScheme(java.lang.String storeScheme)

For internal use only.

getAttributeMap

java.util.Map getAttributeMap()

Returns the names and values of attributes that correspond to the content. The following list specifies content attributes:

• {http://www.alfresco.org/model/content/1.0}creator: Specifies the creator of the content
• {http://www.alfresco.org/model/content/1.0}browse-link: Specifies a link to where the content is stored
• {http://www.alfresco.org/model/system/1.0}store-protocol: Specifies the type of store that is used for the content
• {http://www.alfresco.org/model/content/1.0}title: Specifies a title that is displayed in the web client for the content
• {http://www.alfresco.org/model/system/1.0}node-uuid: Specifies a unique identifier value for the content
• {http://www.alfresco.org/model/content/1.0}node-type: Specifies the cotent type
• {http://www.alfresco.org/model/content/1.0}folder-path: Specifies the content path
• {http://www.alfresco.org/model/system/1.0}store-identifier: Specifies a unique identifier value for the store
• {http://www.alfresco.org/model/content/1.0}description: Specifies a description for the content
• {http://www.alfresco.org/model/content/1.0}resolved-path: Specifies the fully resolved path with namespaces

Returns:

A java.util.Map object that contains the names and values of attributes that correspond to the content.

setAttributeMap

void setAttributeMap(java.util.Map attributeMap)

For internal use only.