|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Read-only interface for Catalog object (holder of Items)
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
Item |
createItem()
Create a new item in the Catalog. |
CatalogHierarchySpecificDetails |
getCatalogHierarchySpecificDetails(Hierarchy hierarchy)
Retrieve an object giving access to details specific to the relationship between this Catalog and a specified Hierarchy, for example, location hierarchy information. |
java.lang.String |
getDisplayName()
Retrieve the name of this Catalog |
PIMCollection |
getHierarchies()
Retrieve all Hierarchies associated with this Catalog |
Item |
getItemByPrimaryKey(int primaryKey)
Retrieve an Item within the catalog using the Item's primary key as an int |
Item |
getItemByPrimaryKey(java.lang.String primaryKey)
Retrieve an Item within the catalog using the Item's primary key as a String |
PIMCollection |
getItems()
Retrieve a collection of all of the Items within this Catalog |
PIMCollection |
getItemsByCategory(Category category)
Retrieve a collection of the Items within this Catalog belong to the specified Category |
Hierarchy |
getPrimaryHierarchy()
Retrieve the primary Hierarchy associated with this Catalog |
PrimarySpec |
getPrimarySpec()
Retrieve the Primary Spec of the Items within this Catalog |
Field Detail |
public static final java.lang.String copyright
Method Detail |
public Item createItem() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic PIMCollection getHierarchies() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationfor more info
public Hierarchy getPrimaryHierarchy() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic Item getItemByPrimaryKey(java.lang.String primaryKey) throws PIMInternalException, PIMAuthorizationException
primaryKey
- String containing the primary key of the item
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic Item getItemByPrimaryKey(int primaryKey) throws PIMInternalException, PIMAuthorizationException
primaryKey
- primary key of the item to be retrieved, as an integer
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic java.lang.String getDisplayName() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic PrimarySpec getPrimarySpec() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationpublic PIMCollection getItems() throws PIMInternalException, PIMAuthorizationException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationfor more info
public PIMCollection getItemsByCategory(Category category) throws PIMInternalException, PIMAuthorizationException
category
- The Category for which to retrieve Items
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operationfor more info
public CatalogHierarchySpecificDetails getCatalogHierarchySpecificDetails(Hierarchy hierarchy) throws PIMInternalException, PIMAuthorizationException
hierarchy
- the Hierarchy for whose relationship with this Catalog, the
specific details will be retrieved
PIMInternalException
- If there an internal error occurs or if specific details
cannot be retrieved
PIMAuthorizationException
- If the user is not allowed to perform this operation
|
||||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |