com.adobe.icc.services.api
Interface CategoryService

public interface CategoryService

Service interface for Category specific operations.

Method Summary

java.lang.Boolean	categoryExists(java.lang.String categoryName, int type) Check if a category exists by the given name and type.
Category	createCategory(java.lang.String categoryName, int type) Create a Category with the given name and type.
void	deleteCategory(java.lang.String categoryID) Delete the category given the Category GUID.
java.util.List	getAllCategories(Query query) Retrieve the list of categories, filtering as per the given Query.
Category	getCategory(java.lang.String categoryID) Fetch a Category object by the given GUID.
java.lang.String	publishCategory(java.lang.String categoryId) Publish Category
Category	readCategory(java.lang.String categoryID) Fetch a Category object by the given GUID.
Category	updateCategory(java.lang.String categoryName, int categoryType, java.lang.String newName, int newType) Update the Category specified by the given name and type, to the new name and type.

Method Detail

categoryExists

java.lang.Boolean categoryExists(java.lang.String categoryName,
                                 int type)
                                 throws ICCException

Check if a category exists by the given name and type.

Parameters:

categoryName - Name of the Category.

type - Type of the Category.

Returns:

True if exists, False otherwise.

Throws:

ICCException

deleteCategory

void deleteCategory(java.lang.String categoryID)
                    throws ICCException

Delete the category given the Category GUID.

Parameters:

categoryID - GUID of the Category.

Throws:

ICCException

getCategory

Category getCategory(java.lang.String categoryID)
                     throws ICCException

Fetch a Category object by the given GUID. This action is not audited for action type Read.

Parameters:

categoryID - GUID of the Category to be fetched.

Returns:

The Category object.

Throws:

ICCException

readCategory

Category readCategory(java.lang.String categoryID)
                      throws ICCException

Fetch a Category object by the given GUID. This action is audited for action type Read.

Parameters:

categoryID - GUID of the Category to be fetched.

Returns:

The Category object.

Throws:

ICCException

createCategory

Category createCategory(java.lang.String categoryName,
                        int type)
                        throws ICCException

Create a Category with the given name and type.

Parameters:

categoryName - Name of the Category.

type - Type of the Category.

Returns:

The created Category object.

Throws:

ICCException

getAllCategories

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

Retrieve the list of categories, filtering as per the given Query.

Parameters:

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

Returns:

List of Categories

Throws:

ICCException

See Also:

Statement, Query

updateCategory

Category updateCategory(java.lang.String categoryName,
                        int categoryType,
                        java.lang.String newName,
                        int newType)
                        throws ICCException

Update the Category specified by the given name and type, to the new name and type.

Parameters:

categoryName - Old Category name.

categoryType - Old Category type.

newName - New Category name.

newType - New Category type.

Returns:

Updated Category object.

Throws:

ICCException

publishCategory

java.lang.String publishCategory(java.lang.String categoryId)
                                 throws ICCException

Publish Category

Parameters:

categoryId - ID of the category to be published

Returns:

ID of the published category

Throws:

ICCException