com.businessobjects.sdk.plugin.desktop.category
Interface ICategoryBase

All Known Subinterfaces:
ICategory

public interface ICategoryBase

This interface contains methods that allow you to manage categories.


Method Summary
 java.util.Set getDocuments()
           Returns a collection of the IDs of the documents that have been assigned to this category.
 java.lang.String[] getPath()
           Returns the path to the category.
 

Method Detail

getDocuments

public java.util.Set getDocuments()
                           throws SDKException

Returns a collection of the IDs of the documents that have been assigned to this category.

Returns:
A Set of IDs that represent objects that are assigned to this category.
Throws:
SDKException - Throws exception if collection is not found

getPath

public java.lang.String[] getPath()
                           throws SDKException

Returns the path to the category.

Returns:
A String array that contains the category names. The order begins with the name of the parent.
Throws:
SDKException - This is thrown if the process is unsuccessful