com.ibm.pim.interfaces.managers
Interface HierarchyManager

All Superinterfaces:
Manager

public interface HierarchyManager
extends Manager

Read-only interface for the Manager of Hierarchy objects


Field Summary
static java.lang.String copyright
           
 
Method Summary
 PIMCollection getHierarchies()
          Retrieves all Hierarchies available in the current context
 Hierarchy getHierarchyByName(java.lang.String name)
          Retrieves a specific Hierarchy by name
 
Methods inherited from interface com.ibm.pim.interfaces.managers.Manager
getManagerName
 

Field Detail

copyright

public static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getHierarchies

public PIMCollection getHierarchies()
                             throws PIMInternalException,
                                    PIMAuthorizationException
Retrieves all Hierarchies available in the current context

Returns:
A PIMCollection of Hierarchies. Please note this is a lazily instantiated collection
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
for more info, Hierarchy

getHierarchyByName

public Hierarchy getHierarchyByName(java.lang.String name)
                             throws PIMInternalException,
                                    PIMAuthorizationException
Retrieves a specific Hierarchy by name

Parameters:
name - The name of the Hierarchy to be retrieved
Returns:
The Hierarchy matching that name, or null if no matches found.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not allowed to perform this operation
See Also:
Hierarchy