com.ibm.pim.interfaces.managers
Interface CatalogManager

All Superinterfaces:
Manager

public interface CatalogManager
extends Manager

Read-only Interface for the manager of Catalog objects


Field Summary
static java.lang.String copyright
           
 
Method Summary
 Catalog getCatalogByName(java.lang.String name)
          Retrieves a specific Catalog by name
 PIMCollection getCatalogs()
          Retrieves all Catalogs available in the current context
 
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

getCatalogs

public PIMCollection getCatalogs()
                          throws PIMInternalException,
                                 PIMAuthorizationException
Retrieves all Catalogs available in the current context

Returns:
A PIMCollection of Catalogs. 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, Catalog

getCatalogByName

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

Parameters:
name - The name of the Catalog to be retrieved
Returns:
The Catalog 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:
Catalog