com.ibm.pim.catalog
Interface CatalogManager

All Superinterfaces:
Manager

public interface CatalogManager
extends Manager

Catalog Manager, providing methods to create new and retrieve existing Catalog Objects

Since:
6.0.0
See Also:
Context.getCatalogManager()

Field Summary
 
Fields inherited from interface com.ibm.pim.common.Manager
copyright
 
Method Summary
 Catalog createCatalog(PrimarySpec catalogSpec, java.lang.String catalogName, Hierarchy hierarchy)
          Builds a new catalog with the given spec and name and AccessControlGroup.
 Catalog createCatalog(PrimarySpec catalogSpec, java.lang.String catalogName, Hierarchy hierarchy, AccessControlGroup acg)
          Builds a new catalog with the given spec and name.
 java.util.Collection<ScreenType> getApplicableScreenTypes()
          Get all applicable screen types that a View on a catalog can be attached to
 Catalog getCatalog(java.lang.String catalogName)
          Retrieves the latest version of a specified Catalog
 Catalog getCatalog(java.lang.String catalogName, VersionInfo version)
          Retrieves a particular version of a specified Catalog
 Catalog getCatalog(View view)
          Get the Catalog by which a particular view is owned
 java.util.Collection<Catalog> getCatalogs()
          Retrieves all Catalogs available the current user is authorized to list.
 java.util.List<VersionInfo> getVersionInfo(java.lang.String catalogName)
          Retrieves all Version Information for a catalog
 java.util.List<VersionInfo> getVersionInfo(java.lang.String catalogName, java.lang.String versionName)
          Retrieves Version Information for a particular version of a catalog
 
Methods inherited from interface com.ibm.pim.common.Manager
getManagerName
 

Method Detail

createCatalog

Catalog createCatalog(PrimarySpec catalogSpec,
                      java.lang.String catalogName,
                      Hierarchy hierarchy)
Builds a new catalog with the given spec and name and AccessControlGroup. Note: will not persist the Catalog without save().

Parameters:
catalogSpec - PrimarySpec for this Catalog
catalogName - A name for this catalog
hierarchy - Primary hierarchy for the Catalog
Returns:
New Catalog
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalStateException - If the PrimarySpec or Hierarchy have not yet been persisted
java.lang.IllegalArgumentException - If any of the arguments are null or empty

createCatalog

Catalog createCatalog(PrimarySpec catalogSpec,
                      java.lang.String catalogName,
                      Hierarchy hierarchy,
                      AccessControlGroup acg)
Builds a new catalog with the given spec and name. Note:Will not persist the Catalog without save().

Parameters:
catalogSpec - PrimarySpec for this Catalog
catalogName - A name for this catalog
hierarchy - Primary hierarchy for the Catalog
acg - Access Control Group for the Catalog
Returns:
New Catalog
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use.
java.lang.IllegalStateException - If the PrimarySpec, Hierarchy, or AccessControlGroup have not yet been persisted
java.lang.IllegalArgumentException - If any of the arguments are null or empty

getCatalog

Catalog getCatalog(java.lang.String catalogName)
Retrieves the latest version of a specified Catalog

Parameters:
catalogName - 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 does not have the equivalent of Permission.CATALOG_LIST
java.lang.IllegalArgumentException - If the argument is null or empty

getCatalog

Catalog getCatalog(java.lang.String catalogName,
                   VersionInfo version)
Retrieves a particular version of a specified Catalog

Parameters:
catalogName - The name of the Catalog to be retrieved
version - The version info object representing 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 does not have the equivalent of Permission.CATALOG_LIST
java.lang.IllegalArgumentException - If any of the arguments are null or empty

getCatalogs

java.util.Collection<Catalog> getCatalogs()
Retrieves all Catalogs available the current user is authorized to list. As prescribed via Permission.CATALOG_LIST

Returns:
A Collection of Catalogs or an empty list if none exist.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - reserved for future use

getVersionInfo

java.util.List<VersionInfo> getVersionInfo(java.lang.String catalogName)
Retrieves all Version Information for a catalog

Parameters:
catalogName - the Catalog
Returns:
A list of VersionInfo objects or an empty list if the catalog does not exist
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.CATALOG_LIST Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException - If the argument is null

getVersionInfo

java.util.List<VersionInfo> getVersionInfo(java.lang.String catalogName,
                                           java.lang.String versionName)
Retrieves Version Information for a particular version of a catalog

Parameters:
catalogName - the Catalog
versionName - the version of the catalog as a String
Returns:
A list VersionInfo objects for this catalog or an empty list if the Catalog does not exist or the catalog with given version does not exist
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.CATALOG_LIST Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException - If any of the arguments are null

getApplicableScreenTypes

java.util.Collection<ScreenType> getApplicableScreenTypes()
Get all applicable screen types that a View on a catalog can be attached to

Returns:
a collection of screen types that can be used for ScreenViews
Throws:
PIMInternalException - if an internal error occurs

getCatalog

Catalog getCatalog(View view)
Get the Catalog by which a particular view is owned

Parameters:
view - the View object
Returns:
the owning Catalog object
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - If the user does not have the equivalent of Permission.CATALOG_LIST
java.lang.IllegalArgumentException - If the view is not a catalog view or if view is null
java.lang.IllegalStateException - If the view has not yet been persisted