com.adobe.icc.services.api
Interface DocumentService

public interface DocumentService

Service interface for PortfolioDocument specific operations.

Method Summary

PortfolioDocument	activateDocument(java.lang.String documentID, boolean updateDependencies) Deprecated.
PortfolioDocument	createDocument(PortfolioDocument Document) Create a new PortfolioDocument object.
PortfolioDocument	createTestDocument(java.lang.String documentID) Deprecated.
void	deleteDocument(java.lang.String documentID) Deprecated.
java.lang.Boolean	documentExists(java.lang.String documentName) Check if a Document exists by the given name.
java.util.List	getAllDocuments(Query query) List all PortfolioDocuments filtered by the given Query.
java.util.List	getDependentPortfolios(java.lang.String documentID) The method returns a List of Portfolios that depend on the Document identified by the given documentID.
PortfolioDocument	getDocument(java.lang.String documentID) Fetch the PortfolioDocument identified by the given documentID.
boolean	isReferenced(java.lang.String documentID) Check if this Document is being referenced by any other asset (Portfolio/Document).
PortfolioDocument	markReadyToPublish(java.lang.String documentID) Mark as ready to publish the PortfolioDocument identified by the given documentID.
PortfolioDocument	publishDocument(java.lang.String documentID) Publish the PortfolioDocument identified by the given documentID.
PortfolioDocument	readDocument(java.lang.String documentID) Fetch the PortfolioDocument identified by the given documentID.
PortfolioDocument	retrieveVersion(java.lang.String documentId, java.util.Date publishDate) Returns the version of document that was published on or before the specified date.
PortfolioDocument	revertToLastPublished(java.lang.String documentId) Reverts the document to the last published version.
boolean	updateDependencies(java.lang.String oldDocumentID, java.lang.String newDocumentID) Update the references of the old Document, in any dependent assets, with the new Document.
PortfolioDocument	updateDocument(PortfolioDocument Document) Update the given PortfolioDocument object.

Method Detail

createDocument

PortfolioDocument createDocument(PortfolioDocument Document)
                                 throws ICCException

Create a new PortfolioDocument object.

Parameters:

Document - The PortfolioDocument object to be created

Returns:

The created PortfolioDocument object

Throws:

ICCException

createTestDocument

PortfolioDocument createTestDocument(java.lang.String documentID)
                                     throws ICCException

Deprecated.

Create a Test/Inactive version of a PortfolioDocument object, given the ID.

Parameters:

documentID - ID of the Document whose Inactive version is to be created.

Returns:

Created Inactive version of a PortfolioDocument object

Throws:

ICCException

deleteDocument

void deleteDocument(java.lang.String documentID)
                    throws ICCException

Deprecated.

Delete the PortfolioDocument identified by the given documentID.

Parameters:

documentID - ID of the Document to be deleted.

Throws:

ICCException

markReadyToPublish

PortfolioDocument markReadyToPublish(java.lang.String documentID)
                                     throws ICCException

Mark as ready to publish the PortfolioDocument identified by the given documentID.

Parameters:

documentID - ID of the PortfolioDocument.

Returns:

PortfolioDocument object marked for publishing

Throws:

ICCException

Since:

10.0.0.0

activateDocument

PortfolioDocument activateDocument(java.lang.String documentID,
                                   boolean updateDependencies)
                                   throws ICCException

Deprecated.

Activate the PortfolioDocument identified by the given documentID.

Parameters:

documentID - Name of the Document to be activated

updateDependencies - Whether to set this new activated version in the dependent Assets.

Returns:

The activated PortfolioDocument object.

Throws:

ICCException

publishDocument

PortfolioDocument publishDocument(java.lang.String documentID)
                                  throws ICCException

Publish the PortfolioDocument identified by the given documentID.

Parameters:

documentID - Name of the Document to be published

Returns:

The activated PortfolioDocument object.

Throws:

ICCException

Since:

10.0.0.0

updateDocument

PortfolioDocument updateDocument(PortfolioDocument Document)
                                 throws ICCException

Update the given PortfolioDocument object.

Parameters:

Document - The PortfolioDocument object to update

Returns:

The updated PortfolioDocument object

Throws:

ICCException

getAllDocuments

java.util.List getAllDocuments(Query query)
                               throws ICCException

List all PortfolioDocuments filtered by the given Query.

Parameters:

query - Query to select documents (supports only first level attributes/properties of an object).
The "attributeName" used in the Statement object should be the name of the property in the object (Document object, in this case).

Returns:

List of PortfolioDocument objects.

Throws:

ICCException

See Also:

Statement, Query

getDocument

PortfolioDocument getDocument(java.lang.String documentID)
                              throws ICCException

Fetch the PortfolioDocument identified by the given documentID. This action is not audited for action type Read.

Parameters:

documentID - Id of the Document to be fetched.

Returns:

The PortfolioDocument identified by the given documentID.

Throws:

ICCException

readDocument

PortfolioDocument readDocument(java.lang.String documentID)
                               throws ICCException

Fetch the PortfolioDocument identified by the given documentID. This action is audited for action type Read.

Parameters:

documentID - Id of the Document to be fetched.

Returns:

The PortfolioDocument identified by the given documentID.

Throws:

ICCException

documentExists

java.lang.Boolean documentExists(java.lang.String documentName)
                                 throws ICCException

Check if a Document exists by the given name.

Parameters:

documentName - Name of the Document.

Returns:

True if a Document exists by the given name, False otherwise.

Throws:

ICCException

getDependentPortfolios

java.util.List getDependentPortfolios(java.lang.String documentID)
                                      throws ICCException

The method returns a List of Portfolios that depend on the Document identified by the given documentID.

Parameters:

documentID - ID of the Document whose dependencies are to be fetched.

Returns:

The dependencies of the given Document.

Throws:

ICCException

isReferenced

boolean isReferenced(java.lang.String documentID)
                     throws ICCException

Check if this Document is being referenced by any other asset (Portfolio/Document).

Parameters:

documentID - ID of the Document whose dependencies are to be fetched.

Returns:

True, if the Document is being referenced, False otherwise.

Throws:

ICCException

updateDependencies

boolean updateDependencies(java.lang.String oldDocumentID,
                           java.lang.String newDocumentID)
                           throws ICCException

Update the references of the old Document, in any dependent assets, with the new Document.

Parameters:

oldDocumentID - ID of the old Document

newDocumentID - ID of the new Document, which should be set as the new reference

Returns:

true if the operation succeeds, false otherwise

Throws:

ICCException

revertToLastPublished

PortfolioDocument revertToLastPublished(java.lang.String documentId)
                                        throws ICCException

Reverts the document to the last published version. If document is not published, it is removed from repository.

Parameters:

documentId - The Document ID.

Returns:

Reverted document.

Throws:

ICCException

Since:

10.0.0.0

retrieveVersion

PortfolioDocument retrieveVersion(java.lang.String documentId,
                                  java.util.Date publishDate)

Returns the version of document that was published on or before the specified date.

Parameters:

documentId - The Document ID.

publishDate - specifies the date for fetching published document.

Returns:

version which was published on or before the specified date.

Throws:

ICCException

Since:

10.0.0.0