com.ibm.pim.interfaces.hierarchy
Interface Hierarchy
- public interface Hierarchy
Read-only interface for Hierarchy object
Field Summary |
static java.lang.String |
copyright
IBM standard copyright |
copyright
public static final java.lang.String copyright
- IBM standard
copyright
getCategoryByPath
public Category getCategoryByPath(java.lang.String sPath)
throws PIMInternalException,
PIMAuthorizationException
- Retrieves a Category within the Hierarchy, or returns null if it is not found.
- Parameters:
sPath
- A String containig a slash-delimited (/) path to the category you wish to retrieve- Returns:
- a Category object for the requested category, or null if not found
- Throws:
PIMInternalException
- if an internal exception occursPIMAuthorizationException
- if an authorization problem occurs
getRootCategory
public Category getRootCategory()
throws PIMInternalException,
PIMAuthorizationException
- Returns the root category for this Hierarchy
- Returns:
- the root Category oject for this Hierarchy
- Throws:
PIMInternalException
- if an internal exception occursPIMAuthorizationException
- if an authorization problem occurs
getDisplayName
public java.lang.String getDisplayName()
throws PIMInternalException,
PIMAuthorizationException
- Returns the display name of this Hierarchy
- Returns:
- a String containing the display name of this Hierarchy
- Throws:
PIMInternalException
- if an internal exception occursPIMAuthorizationException
- if an authorization problem occurs