com.adobe.icc.services.api
Interface PortfolioService

public interface PortfolioService

Service interface for Portfolio specific operations.

Method Summary

Portfolio	activatePortfolio(String portfolioID) Deprecated.
Portfolio	createPortfolio(Portfolio portfolio) Create a new Portfolio object.
Portfolio	createTestPortfolio(String portfolioID) Deprecated.
void	deletePortfolio(String portfolioID) Deprecated.
List	getAllPortfolios(Query query) List all Portfolios filtered by the given Query.
Portfolio	getPortfolio(String portfolioID) Fetch the Portfolio identified by the given portfolioID.
Portfolio	markReadyToPublish(String portfolioID) Mark as ready to publish the Portfolio identified by the given portfolioID.
Boolean	portfolioExists(String portfolioName) Check if a Portfolio exists by the given name.
Portfolio	publishPortfolio(String portfolioID) Publish the Portfolio identified by the given portfolioID.
Portfolio	retrieveVersion(String portfolioId, Date publishDate) Returns the version of portfolio that was published on or before the specified date.
Portfolio	revertToLastPublished(String portfolioId) Reverts the portfolio to the last published version.
Portfolio	updatePortfolio(Portfolio portfolio) Update the given Portfolio.

Method Detail

createPortfolio

Portfolio createPortfolio(Portfolio portfolio)
                          throws ICCException

Create a new Portfolio object.

Parameters:

portfolio - The Portfolio to be created.

Returns:

created Portfolio object

Throws:

ICCException

createTestPortfolio

Portfolio createTestPortfolio(String portfolioID)
                              throws ICCException

Deprecated.

Create Test/Inactive version of Portfolio object.

Parameters:

portfolioID - ID of the Portfolio whose Inactive version is to be created.

Returns:

created Test/Inactive version Portfolio object.

Throws:

ICCException

deletePortfolio

void deletePortfolio(String portfolioID)
                     throws ICCException

Deprecated.

Delete the Portfolio identified by the given portfolioID.

Parameters:

portfolioID - ID of the Portfolio.

Throws:

ICCException

markReadyToPublish

Portfolio markReadyToPublish(String portfolioID)
                             throws ICCException

Mark as ready to publish the Portfolio identified by the given portfolioID.

Parameters:

portfolioID - ID of the Portfolio.

Returns:

Portfolio object marked for publishing

Throws:

ICCException

Since:

10.0.0.0

activatePortfolio

Portfolio activatePortfolio(String portfolioID)
                            throws ICCException

Deprecated.

Activate the Portfolio identified by the given portfolioID.

Parameters:

portfolioID - ID of the Portfolio.

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

Returns:

activated Portfolio object

Throws:

ICCException

publishPortfolio

Portfolio publishPortfolio(String portfolioID)
                           throws ICCException

Publish the Portfolio identified by the given portfolioID.

Parameters:

portfolioID - ID of the Portfolio.

Returns:

activated Portfolio object

Throws:

ICCException

Since:

10.0.0.0

updatePortfolio

Portfolio updatePortfolio(Portfolio portfolio)
                          throws ICCException

Update the given Portfolio.

Parameters:

portfolio - Portfolio object to be updated.

Returns:

updated Portfolio object.

Throws:

ICCException

getAllPortfolios

List getAllPortfolios(Query query)
                      throws ICCException

List all Portfolios filtered by the given Query.

Parameters:

query - Query to select Portfolios (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 (Form object, in this case).

Returns:

List of Portfolio objects

Throws:

ICCException

See Also:

Statement} and {@link Query}.

getPortfolio

Portfolio getPortfolio(String portfolioID)
                       throws ICCException

Fetch the Portfolio identified by the given portfolioID.

Parameters:

portfolioID - ID of the Portfolio to be fetched.

Returns:

the Portfolio identified by the given portfolioID.

Throws:

ICCException

portfolioExists

Boolean portfolioExists(String portfolioName)
                        throws ICCException

Check if a Portfolio exists by the given name.

Parameters:

portfolioName - Name of the Portfolio.

Returns:

true if exists, false otherwise.

Throws:

ICCException

revertToLastPublished

Portfolio revertToLastPublished(String portfolioId)
                                throws ICCException

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

Parameters:

portfolioId - The Portfolio ID.

Returns:

Reverted portfolio.

Throws:

ICCException

Since:

10.0.0.0

retrieveVersion

Portfolio retrieveVersion(String portfolioId,
                          Date publishDate)

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

Parameters:

portfolioId - The Portfolio ID.

publishDate - specifies the date for fetching published portfolio.

Returns:

version which was published on or before the specified date.

Throws:

ICCException

Since:

10.0.0.0