|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CatalogManager
Catalog Manager, providing methods to create new and retrieve existing Catalog Objects
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 |
---|
Catalog createCatalog(PrimarySpec catalogSpec, java.lang.String catalogName, Hierarchy hierarchy)
catalogSpec
- PrimarySpec for this CatalogcatalogName
- A name for this cataloghierarchy
- Primary hierarchy for the Catalog
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 emptyCatalog createCatalog(PrimarySpec catalogSpec, java.lang.String catalogName, Hierarchy hierarchy, AccessControlGroup acg)
catalogSpec
- PrimarySpec for this CatalogcatalogName
- A name for this cataloghierarchy
- Primary hierarchy for the Catalogacg
- Access Control Group for the Catalog
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 emptyCatalog getCatalog(java.lang.String catalogName)
catalogName
- The name of the Catalog to be retrieved
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 emptyCatalog getCatalog(java.lang.String catalogName, VersionInfo version)
catalogName
- The name of the Catalog to be retrievedversion
- The version info object representing the Catalog to be
retrieved
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 emptyjava.util.Collection<Catalog> getCatalogs()
Permission.CATALOG_LIST
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- reserved for future usejava.util.List<VersionInfo> getVersionInfo(java.lang.String catalogName)
catalogName
- the Catalog
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 nulljava.util.List<VersionInfo> getVersionInfo(java.lang.String catalogName, java.lang.String versionName)
catalogName
- the CatalogversionName
- the version of the catalog as a String
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 nulljava.util.Collection<ScreenType> getApplicableScreenTypes()
PIMInternalException
- if an internal error occursCatalog getCatalog(View view)
view
- the View object
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |