com.crystaldecisions.sdk.occa.infostore
Interface ICategoryContent

All Known Subinterfaces:

IAgnostic, IExcel, IFullClient, IHyperlink, IObjectPackage, IPDF, IPowerPoint, IProgram, IPublication, IReport, IRTF, ITxt, IWebi, IWord

public interface ICategoryContent

This interface allows you to manage categories for documents and reports.

Note: In order to query for Categories and their associated subcategories , you will have to query for both the SI_CORPORATE_CATEGORIES and the SI_CHILDREN properties. Furthermore, you can also use the CATEGORY constant to query for all of the dynamically generated objects that are related to a specific ICategory object. This includes objects that have been assigned to this category, such as reports or documents.

Note: To query for Personal Categories and their associated subcategories, you will have to query for both the SI_PERSONAL_CATEGORIES and the SI_CHILDREN properties.

Method Summary

java.util.Set	getCorporateCategories() Returns the ID set of top-level categories that have been assigned to the object.
java.util.Set	getPersonalCategories() Returns the ID set of top-level personal categories that have been assigned to the object.

Method Detail

getCorporateCategories

java.util.Set getCorporateCategories()
                                     throws SDKException

Returns the ID set of top-level categories that have been assigned to the object.

Returns:

A Set of category IDs that have been assigned to the object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_CORPORATE_CATEGORIES

getPersonalCategories

java.util.Set getPersonalCategories()
                                    throws SDKException

Returns the ID set of top-level personal categories that have been assigned to the object.

Returns:

A Set of personal category IDs that have been assigned to the object.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_PERSONAL_CATEGORIES