|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface DocumentManagementServiceClient
The DocumentManagementServiceClient class enables you to programmatically perform
operations supported by the LiveCycle ES2 service named Document Management.
Using an object
of this type, you can perform tasks such as the following:
DocumentManagementServiceClient object, see
Performing Document Management Operations Using APIs in Programming with LiveCycle ES4.
| Method Summary | |
|---|---|
java.util.Map |
cancelCheckOut(java.lang.String storeName,
java.util.List nodeIDsOrPaths)
Cancels check out of a given list of content nodes. |
java.util.Map |
checkIn(java.lang.String storeName,
java.util.List nodeIDsOrPaths,
VersionType versionType,
java.lang.Boolean keepCheckedOut,
java.lang.Boolean revokePrevious,
java.util.Map versionAttributes)
Performs check-ins with suitable options for a list of nodes. |
java.util.Map |
checkOut(java.lang.String storeName,
java.util.List nodeIDsOrPaths,
java.lang.String destinationNodeOrPath)
Checks out a given list of content nodes List of versions are returned in a NodeVersion instance. |
java.lang.String |
copyContent(java.lang.String storeName,
java.lang.String sourceDocumentIDOrPath,
java.lang.String targetContentPath)
Copies content from one Content Services ES2 location to another location. |
void |
createAssociation(java.lang.String storeName,
java.lang.String associationType,
java.lang.String parentNodeIDOrPath,
java.lang.String childNodeIDOrPath)
Creates an association between content located in Content Services ES2. |
java.lang.String |
createSpace(java.lang.String storeName,
java.lang.String spacePath)
Creates a new Content Services ES2 space. |
java.lang.String |
createSpace(java.lang.String storeName,
java.lang.String spacePath,
TemplateOptionsSpec templateOptions,
java.lang.String templateName)
Creates a new Content Services ES2 space, based on the template specified. |
java.lang.Boolean |
deleteContent(java.lang.String storeName,
java.lang.String nodeIDOrPath)
Deletes the specified content from Content Services ES2. |
java.util.List |
getAspectsList()
Returns the different type of Content Services aspects that can be applied on content. |
java.util.List |
getAssociated(java.lang.String storeName,
java.lang.String associationType,
java.lang.String nodeIDOrPath,
java.lang.Boolean isParent)
Retrieves an association that exists between content. |
java.util.List |
getAssociationTypesList(java.lang.String storeName)
Returns a list of association types that are present. |
java.util.Map |
getContentAttributes(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.lang.String versionLabel)
Retrieves all attributes that are associated with content in a Content Services ES2 space. |
java.util.List |
getNodeTypes()
Returns the different type of Content Services nodes that can be created. |
java.util.List |
getSpaceContents(java.lang.String storeName,
java.lang.String spaceIDOrPath,
java.lang.Boolean getOnlyFiles)
Retrieves the contents of the specified space. |
java.util.List |
getVersionHistory(java.lang.String storeName,
java.lang.String spaceIDOrPath,
java.lang.Boolean isAscending)
Retrieves the version history of a node. |
java.lang.Boolean |
importContent(java.lang.String storeName,
java.lang.String spacePath,
java.lang.String nodeName,
Document zipDocument,
java.lang.String nodeEncoding)
Imports content into a specified Content Services ES2 space. |
java.lang.String |
moveContent(java.lang.String storeName,
java.lang.String sourceDocumentIDOrPath,
java.lang.String targetContentPath)
Moves content from one Content Services ES2 location to another location. |
ReadPermissionsResult |
readPermissions(java.lang.String storeName,
java.lang.String nodeIDOrPath)
Retrieves access permissions that are applicable to a Content Services ES2 node. |
void |
removeAspects(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.util.List aspects)
Removes the specified aspect from a node. |
CRCResult |
retrieveContent(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.lang.String versionLabel)
Retrieves content from the specified Content Services space. |
ResultSet |
searchRepository(java.lang.String storeName,
java.lang.String basePath,
java.lang.Boolean includeSubDir,
Query query,
java.lang.Integer maxSize)
Searches Content Services for content. |
void |
setContentAttributes(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.util.List aspects,
java.util.Map attributeMap)
Sets content attributes. |
CRCResult |
storeContent(java.lang.String storeName,
java.lang.String spacePath,
java.lang.String nodeName,
java.lang.String nodeType,
Document nodeContent,
java.lang.String nodeEncoding,
UpdateVersionType updateVersionType,
java.util.List aspects,
java.util.Map attributeMap)
Stores content in a specified Content Services ES2 space. |
void |
writePermissions(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.util.List accessPermissions,
java.lang.Boolean inheritParentPermissions)
Sets access permissions that are applicable to a Content Services ES2 node. |
| Method Detail |
|---|
java.lang.String createSpace(java.lang.String storeName,
java.lang.String spacePath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
To see this method used in a code example, see the Creating Content Services ES2 spaces using the Java API quick start in Programming with LiveCycle ES4.
storeName - The store where the space is created. The default value for this parameter is SpacesStore.spacePath - The fully qualified path of the space to create.
The path starts from the root (for example, /Company Home/User Homes/userA/space).
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to create a new space.
java.lang.String createSpace(java.lang.String storeName,
java.lang.String spacePath,
TemplateOptionsSpec templateOptions,
java.lang.String templateName)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
storeName - The store where the space is created. The allowed store value is SpacesStore.
This value is a mandatory parameter.spacePath - The fully qualified path of the space to create.
The path starts from the root (for example, /Company Home/User Homes/userA/space).
This value is a mandatory parameter.templateOptions - A TemplateOptionsSpec enumeration value that controls how the space is created. For
example, specify TemplateOptionsSpec.CREATE_FROM_SPACE to create a new space based on an existing space.templateName - A string value that specifies the name of the template that is used to create a space. If you
specify TemplateOptionsSpec.CREATE_FROM_SPACE, then specify the fully qualified path of the space on which
the new space is based (for example, /Company Home/Test Directory). This value is a mandatory parameter.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to create a new space.
CRCResult storeContent(java.lang.String storeName,
java.lang.String spacePath,
java.lang.String nodeName,
java.lang.String nodeType,
Document nodeContent,
java.lang.String nodeEncoding,
UpdateVersionType updateVersionType,
java.util.List aspects,
java.util.Map attributeMap)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
KEEP_VERSION_SAME: Applies only for content that is not versionable.CHANGE_MAJOR_VERSION: Changes the major version of the content. If the document is not versionable, it is
made versionable first.CHANGE_MINOR_VERSION: Changes the minor version of the content. If the document is not versionable, it is
made versionable first.To see this method used in a code example, see the Add content to Content Services ES2 using the Java API quick start in Programming with LiveCycle ES4.
storeName - The store where the content is added. The allowed store value is SpacesStore.
This value is a mandatory parameter.spacePath - A fully qualified path of the space where the content is added
(for example, /Company Home/Test Directory). This value is a mandatory parameter.nodeName - A string value that represents the content name of the content
(for example, MortgageForm.pdf). This value is a mandatory parameter.nodeType - A string value that represents the node type. The default type is content.
This value is expressed as {http://www.alfresco.org/model/content/1.0}content.
This value is a mandatory parameter.nodeContent - A com.adobe.idp.Document object that represents the data to add.
This value is a mandatory parameter.nodeEncoding - A string value that represents the data encoding type (for example, UTF-8).
This value is a mandatory parameter.updateVersionType - An UpdateVersionType enumeration value that specifies how to handle
version information (for example, specify UpdateVersionType.INCREMENT_MAJOR_VERSION
to increment the content version). This value is a mandatory parameter.attributeMap - A java.util.List instance that specifies aspects related to the content.
This value is an optional parameter and you can specify null.attributeMap - A java.util.Map object that stores content attributes.
CRCResult object that represents the content.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to store content.
CSTransformationException
CRCResult retrieveContent(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.lang.String versionLabel)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
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.
storeName - The store from where the content is retrieved. The allowed store value is SpacesStore.
This value is a mandatory parameter.nodeIDOrPath - The fully qualified node name of the content that is retrieved
(for example, /Company Home/MortgageForm.pdf). This value is a mandatory parameter.versionLabel - A string value that specifies the version that is retrieved (for example, 1.2).
This value is an optional parameter, and you can pass an empty string value.
In this situation, the latest version (head version) is retrieved.
CRCResult object that contains the content along with node attributes.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to retrieve content.
java.util.Map getContentAttributes(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.lang.String versionLabel)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
storeName - The store from where the content attributes are retrieved.
The allowed store value is SpacesStore. This value is a mandatory parameter.nodeIDOrPath - The fully qualified node name of the content whose attributes are retrieved
(for example, /Company Home/MortgageForm.pdf). This value is a mandatory parameter.versionLabel - A string value that specifies the version that is retrieved (for example, 1.2).
This value is an optional parameter, and you can pass an empty string.
In this situation, the latest version is retrieved.
java.util.Map object containing the attributes associated with the specified content.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to retrieve attribute values.
void setContentAttributes(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.util.List aspects,
java.util.Map attributeMap)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
{http://www.alfresco.org/model/content/1.0}description.
Attributes are typically
set when you add content to Content Services ES2 or create associations between content.
For information about other attributes that you can set, see the
Adding Content to Content Services ES2 topic in Programming with LiveCycle ES4.
To see this method used in a code example, see the Creating Associations using the Java API quick start in Programming with LiveCycle ES4.
storeName - A string value that specifies the store where the content is added.
The default store is SpacesStore. This value is a mandatory parameter.nodeIDOrPath - A string value that specifies the fully qualified path to the content
(for example, /Company Home/MortgageForm.pdf). This value is a mandatory parameter.aspects - A java.util.List object that contains an aspect value
(for example, {http://www.adobe.com/lc/datacapture/1.0}linkable).
For information about aspects that you can set, see the
Creating Content Services ES2 Associations topic in Programming with LiveCycle ES4.
This value is a mandatory parameter.attributeMap - A java.util.Map object that contains content attributes.
Multiple value attributes are supported.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to set attributes.
CSTransformationException
void removeAspects(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.util.List aspects)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
storeName - A string value that specifies the store from which an aspect is removed.
The default store is SpacesStore.
This value is a mandatory parameter.nodeIDOrPath - A string value that specifies the fully qualified path to the content
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.aspects - A java.util.List object that contains an aspect value to remove.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to remove an aspect.
CSTransformationException
java.util.List getAssociated(java.lang.String storeName,
java.lang.String associationType,
java.lang.String nodeIDOrPath,
java.lang.Boolean isParent)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
java.util.List object, where each element is a string.
storeName - A string value that specifies the store from which associations are retrieved.
The default store is SpacesStore.
This value is a mandatory parameter.associationType - A string value that specifies the association type
(for example, {http://www.adobe.com/lc/datacapture/1.0}linkedBy).
This value is a mandatory parameter.nodeIDOrPath - A string value that specifies the fully qualified path to the content
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.isParent - A Boolean value that specifies if the content is the parent node.
java.util.List object that contains an association.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to retrieve an association.
java.util.List getAssociationTypesList(java.lang.String storeName)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
storeName - A string value that specifies the store where association types are retrieved.
The default store is SpacesStore.
This value is a mandatory parameter.
java.util.List object that contains association types.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to retrieve association types.
void createAssociation(java.lang.String storeName,
java.lang.String associationType,
java.lang.String parentNodeIDOrPath,
java.lang.String childNodeIDOrPath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
linkedBy: An association between an XML data file and a PDF form.
The XML file must have the aspect linkable applied to it.
This association is a many-to-one association, which means that multiple data files
can be associated with the same PDF form.linkedTo: An association between two PDF documents.
The source document must have the aspect PDFToPDFLink applied to it.
This association is a many-to-one association,
which means that two or more documents can be linked together.linkedToXML: An association between an XDP Document attachment and the XDP data XML file.
The attachment must have the aspect xdpAttachment applied to it.
This association is a many-to-one association,
which means that multiple XDP Document attachments
can be associated with a single XML file.To see this method used in a code example, see the Creating Associations using the Java API quick start in Programming with LiveCycle ES4.
storeName - A string value that specifies the store in which an association is created.
The default store is SpacesStore. This value is a mandatory parameter.associationType - A string value that specifies the association type.
For example, to create a linkedBy association,
pass {http://www.adobe.com/lc/datacapture/1.0}linkable.
This value is a mandatory parameter.parentNodeIDOrPath - A string value that specifies the fully qualified path to the parent content.
For example, if you create a linkedBy association, specify the path to the PDF document.
This value is a mandatory parameter.childNodeIDOrPath - A string value that specifies the fully qualified path to the child content.
For example, if you create a linkedBy association, specify the path to the XML document.
This value is a mandatory parameter.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to create an association.
java.lang.Boolean deleteContent(java.lang.String storeName,
java.lang.String nodeIDOrPath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
To see this method used in a code example, see the Delete Content Services ES2 content using the Java API quick start in Programming with LiveCycle ES4.
storeName - A string value that specifies the store where the content is deleted.
The default store is SpacesStore. This value is a mandatory parameter.documentIDOrPath - A string value that specifies the fully qualified path to the content to delete
(for example, /Company Home/Test Directory).
This value is a mandatory parameter.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to delete content.
java.lang.String copyContent(java.lang.String storeName,
java.lang.String sourceDocumentIDOrPath,
java.lang.String targetContentPath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
storeName - A string value that specifies the store where the content is copied.
The default store is SpacesStore. This value is a mandatory parameter.sourceDocumentIDOrPath - A string value that specifies the fully qualified path to the content to copy
(for example, /Company Home/Test Directory/MortgageForm.pdf).
This value is a mandatory parameter.targetContentPath - A string value that specifies the fully qualified path of the location to which the content is copied.
This value is a mandatory parameter.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to copy content.
CSTransformationException
java.lang.String moveContent(java.lang.String storeName,
java.lang.String sourceDocumentIDOrPath,
java.lang.String targetContentPath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
To see this method used in a code example, see the Move Content Services ES2 content using the Java API quick start in Programming with LiveCycle ES4.
storeName - A string value that specifies the store where the content is moved.
The default store is SpacesStore. This value is a mandatory parameter.sourceDocumentIDOrPath - A string value that specifies the fully qualified path to the content to move
(for example, /Company Home/Test Directory/MortgageForm.pdf).
This value is a mandatory parameter.targetContentPath - A string value that specifies the fully qualified path of the location to which the content is moved.
This value is a mandatory parameter.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to move content.
CSTransformationException
java.util.List getNodeTypes()
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
java.util.List object where each node is a string that specifies the node types.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to retrieve node types.
java.util.List getAspectsList()
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
java.util.List object where each node is a string that specifies an aspect.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services ES2 attempts to retrieve node types.
java.util.List getSpaceContents(java.lang.String storeName,
java.lang.String spaceIDOrPath,
java.lang.Boolean getOnlyFiles)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
CRCResult instance.
This method returns a list of all the documents that are present in a space.
In contrast, the RetrieveContent method gets a specified node.
storeName - A string value that specifies the store where the content is moved.
The default store is SpacesStore. This value is a mandatory parameter.spaceIDOrPath - The fully qualified node name of the content that is retrieved
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.onlyFiles - A Boolean value that specifies whether only files are retrieved. This value is a mandatory parameter.
java.util.List object where each node is a CRCResult object that contains content.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to retrieve content.
java.util.List getVersionHistory(java.lang.String storeName,
java.lang.String spaceIDOrPath,
java.lang.Boolean isAscending)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
NodeVersion instance.
This method returns a list of all the versions of a node.
storeName - A string value that specifies the store where the node exists for which version history is sought.
The allowed store is SpacesStore. This value is a mandatory parameter.nodeIDOrPath - The fully qualified node path or Id of the content.
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.isAscending - A Boolean value that specifies if the order of versions is ascending or decending, sorted by created Date.
java.util.List object where each node is a NodeVersion object that contains version information.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to retrieve content.
java.util.Map checkOut(java.lang.String storeName,
java.util.List nodeIDsOrPaths,
java.lang.String destinationNodeOrPath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
NodeVersion instance.
This method returns a list of all the versions of a node.
storeName - A string value that specifies the store where the node exists.
The default store is SpacesStore. This value is a mandatory parameter.nodeIDsOrPaths - A list of fully qualified path(s) or Id(s) of the content(s)
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.destinationNodeOrPath - Destination folder where the contents will be checked out.If null,the checked out node will
be placed in the same space as original node.
java.util.Map object where each entry contains the checked out copy Id corresponding to original Node Id or Path.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to retrieve content.
java.util.Map cancelCheckOut(java.lang.String storeName,
java.util.List nodeIDsOrPaths)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
NodeVersion instance.
This method returns a list of all the versions of a node.
storeName - A string value that specifies the store where the content is moved.
The default store is SpacesStore. This value is a mandatory parameter.nodeIDsOrPaths - A list of fully qualified path(s) or Id(s) of the content(s)
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.
java.util.Map object where each entry contains the original Node corresponding the copy reference on which cancel
checkout is performed.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to retrieve content.
java.util.Map checkIn(java.lang.String storeName,
java.util.List nodeIDsOrPaths,
VersionType versionType,
java.lang.Boolean keepCheckedOut,
java.lang.Boolean revokePrevious,
java.util.Map versionAttributes)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
storeName - A string value that specifies the store where the content is moved.
The default store is SpacesStore. This value is a mandatory parameter.nodeIDsOrPaths - A list of fully qualified path(s) or Id(s) of the content(s)
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.versionType - An VersionType enumeration value that specifies how to handle
version information (for example, specify VersionType.MAJOR
to increment the major version). This value is a mandatory parameter.keepCheckedOut - A Boolean value that specifies if the working copy should be kept checked out.revokePrevious - A Boolean value that specifies if the previous versions of a right protected document need to be revoked.
This operation is valid only for MAJOR version changes.versionAttributes - A java.util.Map object that contains version attributes.
Multiple value attributes are supported.
java.util.Map object where each entry contains the original node corresponding the copy reference on which check-
-in is performed.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to retrieve content.
ReadPermissionsResult readPermissions(java.lang.String storeName,
java.lang.String nodeIDOrPath)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
storeName - A string value that specifies the store from which access permissions are retrieved.
The default store is SpacesStore. This value is a mandatory parameter.nodeIDOrPath - The fully qualified node name of the content whose permissions are retrieved
(for example, /Company Home/MortgageForm.pdf).
This value is a mandatory parameter.
ReadPermissionsResult object that represents permissions.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to retrieve permissions.
void writePermissions(java.lang.String storeName,
java.lang.String nodeIDOrPath,
java.util.List accessPermissions,
java.lang.Boolean inheritParentPermissions)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
ContentServicesException
To see this method used in a code example, see the Setting Content Services ES Permissions using the Java API quick start in Programming with LiveCycle ES4.
storeName - A string value that specifies the store where access permissions are set.
The default store is SpacesStore. This value is a mandatory parameter.nodeIDOrPath - The fully qualified node name of the content whose permissions are set
(for example, /Company Home/Test Directory).
This value is a mandatory parameter.accessPermissions - A java.util.List object where each element is a ContentAccessPermission object
that represents a permission. This value is a mandatory parameter.inheritParentPermissions - A Boolean value that specifies whether to inherit permissions from the parent node.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to set permissions.
java.lang.Boolean importContent(java.lang.String storeName,
java.lang.String spacePath,
java.lang.String nodeName,
Document zipDocument,
java.lang.String nodeEncoding)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
storeName - A string value that specifies the store where the content is imported.
The default store is SpacesStore. This value is a mandatory parameter.spacePath - The fully qualified node name of the space in which content is imported
(for example, /Company Home/Test Directory).
This value is a mandatory parameter.nodeName - The name of the ZIP file that is added to the Content Services space.
This value is a mandatory parameter.zipDocument - A com.adobe.idp.Document object that represents the content that is imported.
This value is a mandatory parameter.nodeEncoding - A string value that represents the data encoding type (for example, UTF-8).
This value is a mandatory parameter.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to import content.
CSTransformationException
ResultSet searchRepository(java.lang.String storeName,
java.lang.String basePath,
java.lang.Boolean includeSubDir,
Query query,
java.lang.Integer maxSize)
throws CSAccessDeniedException,
CSAuthenticationException,
CSCommunicationException,
CSInvalidParameterException,
CSInvocationException,
CSTransformationException,
ContentServicesException
To see this method used in a code example, see the Search Content Services ES2 content using the Java API quick start in Programming with LiveCycle ES4.
storeName - A string value that specifies the store where a search is performed.
The default store is SpacesStore. This value is a mandatory parameter.basePath - A string value that specifies the path where the search is performed (for example, /Company Home).
This value is a mandatory parameter.includeSubDir - A Boolean value that specifies whether to search sub folders located in the specified path.
The value true indicates to search sub folders.query - A Query object that represents the query statement.maxSize - An integer value that specifies the maximum value for the return set.
ResultSet object that contains the search results.
CSAccessDeniedException - If the user does not have permission to access this operation.
CSAuthenticationException - If the user is not authenticated.
CSCommunicationException - If a communication error occurred.
CSInvalidParameterException - If an invalid parameter is specified.
CSInvocationException - If an error occurred while the client application invoked LiveCycle ES2.
ContentServicesException - If an error occurred while Content Services attempts to search for content.
CSTransformationException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||