|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Catalog
Catalogs are repositories or containers for items
Additional optional parameters can be specified for any catalog (Secondary category hierarchy, Linked catalogs, catalogs scripts used for pre and post processing) Catalogs can be linked, allowing attributes to be managed for a single item across multiple catalogs. Catalog views can be customized to personalize how item attributes are presented to a user
CatalogManager
Field Summary |
---|
Fields inherited from interface com.ibm.pim.common.Batchable |
---|
copyright |
Method Summary | |
---|---|
void |
addCustomParameterValue(java.lang.String key,
java.lang.String value)
Add the given value to the set of values for the custom parameter with the given name. |
LocationDataConfiguration |
addLocationDataConfiguration(Hierarchy hierarchy,
SecondarySpec spec)
Adds location specific data for a catalog. |
void |
addSecondaryHierarchy(Hierarchy hierarchy)
Add the hierarchy as a secondary hierarchy to this Catalog |
void |
addSecondaryHierarchy(OrganizationHierarchy orgHierarchy)
Add the Organization hierarchy as a secondary hierarchy to this Catalog |
boolean |
containsItem(java.lang.String itemPrimaryKey)
Identifies if the catalog contains an item with the given primary key. |
Item |
createItem()
Create a new item in the Catalog. |
ItemUserDefinedLog |
createUserDefinedLog(java.lang.String name,
boolean runningLog)
Creates an ItemUserDefinedLog for this Catalog |
VersionInfo |
createVersion(java.lang.String versionName)
Create a new version of this Catalog |
View |
createView(java.lang.String viewName)
create a new empty View for this catalog |
Schedule |
deleteAsynchronous()
Schedules the complete catalog deletion. |
void |
deleteCustomParameter(java.lang.String name)
Deletes a User Defined custom parameter for this Catalog |
AccessControlGroup |
getAccessControlGroup()
Returns the Access Control Group for this catalog |
PIMCollection<SecondarySpec> |
getCategorySpecs()
Return all the "ItemSecondarySpecs" applied in this catalog |
java.util.Collection<ItemCollaborationArea> |
getCollaborationAreas()
Return all collaboration areas that have this catalog as their source catalog as prescribe by: Permission.COLLABORATION_AREA_LIST |
java.util.List<java.lang.String> |
getCustomParameterNames()
Retrieves a list of user defined custom parameters present in this Catalog |
java.util.List<java.lang.String> |
getCustomParameterValues(java.lang.String name)
Retrieves a User Defined custom parameter for this Catalog |
AttributeDefinition |
getDisplayAttribute()
Retrieves the Catalog display attribute |
Document |
getItemBuildScript()
Retrieves the script document associated with an invocation point defined by the Catalog |
Item |
getItemByPrimaryKey(java.lang.String primaryKey)
Retrieve an Item within the catalog using the Item's primary key as a String |
PIMCollection<Item> |
getItems()
Retrieve a collection of all of the Items within this Catalog |
java.util.List<Item> |
getItemsByPrimaryKeys(java.util.List<java.lang.String> primaryKeys)
Returns a collection of items from this catalog described by their primary keys |
PIMCollection<Item> |
getItemsWithAttributeValue(java.lang.String attributeInstancePath,
java.lang.Object value)
Returns a collection of items from this catalog where the specified attribute instance has the specified value |
java.util.List<LocationDataConfiguration> |
getLocationDataConfigurations()
Retrieves all location specific data for the current catalog. |
java.util.Collection<Hierarchy> |
getLocationHierarchies()
Returns a collection of location hierarchies applicable to this Catalog. |
java.lang.String |
getName()
Retrieves the Catalog name |
Document |
getPostSaveScript()
Retrieves the script document associated with an invocation point defined by the Catalog |
Document |
getPostScript()
Retrieves the script document associated with an invocation point defined by the Catalog |
Document |
getPreScript()
Retrieves the script document associated with an invocation point defined by the Catalog |
Hierarchy |
getPrimaryHierarchy()
Retrieve the primary Hierarchy associated with this Catalog |
ProcessingOptions |
getProcessingOptions()
Provide temporary ways to change the default behavior for performance reasons. |
java.util.Collection<Hierarchy> |
getSecondaryHierarchies()
Retrieve all secondary Hierarchies associated with this Catalog. |
java.util.Collection<OrganizationHierarchy> |
getSecondaryOrganizationHierarchies()
Retrieve all organization Hierarchies associated as secondary hierarchies with this Catalog. |
PrimarySpec |
getSpec()
Retrieve the Primary Spec of the Items within this Catalog. |
PIMCollection<Item> |
getUnassignedItems(Hierarchy hierarchy)
Returns a collection of items from this catalog belonging to a specific hierarchy which are unassigned to a category |
AttributeCollection |
getUserDefinedAttributeCollection()
Retrieves the User Defined Core Attribute Collection for this Catalog |
ItemUserDefinedLog |
getUserDefinedLog(java.lang.String name)
Retrieves a specific ItemUserDefinedLog associated with this catalog with a specified name |
java.util.Collection<ItemUserDefinedLog> |
getUserDefinedLogs()
Retrieves all ItemUserDefinedLog available in the current context for this Catalog |
VersionInfo |
getVersionInfo()
Retrieves version information for this Catalog |
View |
getView(java.lang.String name)
retrieve a View on this catalog by name |
java.util.Collection<View> |
getViews()
Retrieve all Views on this catalog. |
boolean |
isItemCheckedOut(java.lang.String itemPrimaryKey)
Identifies if an item is checked out |
boolean |
isOrdered()
Identifies if an item within a catalog is ordered or not |
void |
link(Catalog catalog,
AttributeDefinition sourceAttribute,
AttributeDefinition destinationAttribute)
Links a catalog to another using source and destination attributes. |
void |
removeLink(AttributeDefinition sourceAttribute)
Removes an existing link between catalogs. |
void |
removeSecondaryHierarchy(Hierarchy hierarchy)
removes a hierarchy from the catalog |
void |
removeSecondaryHierarchy(OrganizationHierarchy orgHierarchy)
removes an organization hierarchy from the catalog |
Schedule |
rollbackAsynchronous(VersionInfo version)
Schedules a catalog rollback. |
boolean |
save()
Persists the catalog to the database. |
void |
setAccessControlGroup(AccessControlGroup accessControlGroup)
Sets the Access Control Group for this catalog |
void |
setDisplayAttribute(AttributeDefinition displayAttribute)
Describes the Catalog display attribute |
void |
setItemBuildScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Catalog |
void |
setOrdered(boolean setOrdered)
Changes the catalog to allow ordering or not. |
void |
setPostSaveScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Catalog |
void |
setPostScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Catalog |
void |
setPreScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Catalog |
void |
setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
Specifies the User Defined Core Attribute Collection for this Catalog |
Methods inherited from interface com.ibm.pim.common.Batchable |
---|
flushBatch, getBatchProcessingStatistics, startBatchProcessing, stopBatchProcessing |
Method Detail |
---|
LocationDataConfiguration addLocationDataConfiguration(Hierarchy hierarchy, SecondarySpec spec)
hierarchy
- the hierarchy to be used for location data.spec
- the secondary spec to be used for this location data
structure.
PIMInternalException
- If an internal error occurs
java.lang.IllegalStateException
- If the Catalog has not yet been persisted
java.lang.IllegalArgumentException
- If any of the passed arguments are null
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
void addSecondaryHierarchy(Hierarchy hierarchy)
hierarchy
- The secondary hierarchy
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
void addSecondaryHierarchy(OrganizationHierarchy orgHierarchy)
orgHierarchy
- The secondary organization hierarchy
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null
java.lang.IllegalStateException
- if the API object passed as a parameter has not yet been
saved.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
boolean containsItem(java.lang.String itemPrimaryKey)
itemPrimaryKey
- the item primary key
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null or empty
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
Item createItem()
PIMInternalException
- If an internal error occurs
java.lang.IllegalStateException
- If the Catalog has not yet been persisted
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ADD_ITEMS
VersionInfo createVersion(java.lang.String versionName)
versionName
- The name of the version
PIMInternalException
- If an internal error occurs
java.lang.IllegalStateException
- If the Catalog has not yet been persisted
java.lang.IllegalArgumentException
- If the passed argument is null or empty
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
Schedule deleteAsynchronous()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_DELETE
void deleteCustomParameter(java.lang.String name)
name
- the name of the parameter to be deletes
PIMInternalException
- If the custom parameter does not exist or an internal error
occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
getUserDefinedAttributeCollection()
AccessControlGroup getAccessControlGroup()
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null or empty
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
PIMCollection<SecondarySpec> getCategorySpecs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
for more info
PIMCollection<Item> getItems()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
for more info
java.util.Collection<ItemCollaborationArea> getCollaborationAreas()
Permission.COLLABORATION_AREA_LIST
PIMInternalException
- If there an internal error occurs or if specific details
cannot be retrieved
PIMAuthorizationException
- reserved for future usejava.util.List<java.lang.String> getCustomParameterValues(java.lang.String name)
name
- the name of the parameter to be retrieved
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null or empty
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
getUserDefinedAttributeCollection()
java.util.List<java.lang.String> getCustomParameterNames()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
AttributeDefinition getDisplayAttribute()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
Document getItemBuildScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
Item getItemByPrimaryKey(java.lang.String primaryKey)
primaryKey
- String containing the primary key of the item
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null or empty
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
java.util.List<Item> getItemsByPrimaryKeys(java.util.List<java.lang.String> primaryKeys)
primaryKeys
- An List of String keys
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the passed argument is null
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
PIMCollection<Item> getItemsWithAttributeValue(java.lang.String attributeInstancePath, java.lang.Object value)
attributeInstancePath
- -
the attribute instance to be inspectedvalue
- -
the value of the attribute instance to be matched
PIMInternalException
- If an internal error occurs. One reason that this exception
is thrown is if the attributeInstancePath does not specify a
valid path. This exception will also be thrown if the value
is not of a valid data type.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
java.lang.IllegalArgumentException
- If the passed arguments are null or emptyfor more info
java.util.List<LocationDataConfiguration> getLocationDataConfigurations()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.util.Collection<Hierarchy> getLocationHierarchies()
Permission.HIERARCHY_LIST
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.String getName()
PIMInternalException
- If an internal error occursDocument getPostSaveScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
Document getPostScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
Document getPreScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
Hierarchy getPrimaryHierarchy()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
ProcessingOptions getProcessingOptions()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
Permission.CATALOG_ADD_ITEMS
Permission.CATALOG_DELETE_ITEMS
java.util.Collection<Hierarchy> getSecondaryHierarchies()
Permission.HIERARCHY_LIST
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.util.Collection<OrganizationHierarchy> getSecondaryOrganizationHierarchies()
Permission.HIERARCHY_LIST
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
PrimarySpec getSpec()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
PIMCollection<Item> getUnassignedItems(Hierarchy hierarchy)
hierarchy
- The hierarchy object
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
java.lang.IllegalArgumentException
- If the passed argument is nullfor more info
AttributeCollection getUserDefinedAttributeCollection()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
VersionInfo getVersionInfo()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
boolean isItemCheckedOut(java.lang.String itemPrimaryKey)
itemPrimaryKey
- the item primary key to search on
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
java.lang.IllegalArgumentException
- If the passed argument is null or emptyboolean isOrdered()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
void link(Catalog catalog, AttributeDefinition sourceAttribute, AttributeDefinition destinationAttribute)
catalog
- the destination catalogsourceAttribute
- The source attribute to link from.destinationAttribute
- The destination attribute to link to.
java.lang.IllegalStateException
- If the object is in an invalid state
java.lang.IllegalArgumentException
- If any of the arguments are null
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid removeLink(AttributeDefinition sourceAttribute)
sourceAttribute
- The source attribute of the link.
java.lang.IllegalArgumentException
- If sourceAttribute argument is null
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid removeSecondaryHierarchy(OrganizationHierarchy orgHierarchy)
orgHierarchy
- the organization hierarchy to remove. If the organization hierarchy
is currently not associated with the catalog as a secondary hierarchy,
then this method will have no effect.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is null
java.lang.IllegalStateException
- if the API object passed as a parameter has not yet been
saved.void removeSecondaryHierarchy(Hierarchy hierarchy)
hierarchy
- the hierarchy to remove if this is not part of the
getHierarchies list, this will have no effect
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullSchedule rollbackAsynchronous(VersionInfo version)
version
- the Version object of the catalog to use
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ROLLBACK
void setAccessControlGroup(AccessControlGroup accessControlGroup)
accessControlGroup
- Access Control Group for this catalog
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullboolean save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
void addCustomParameterValue(java.lang.String key, java.lang.String value)
key
- the reference.value
- the value of the attribute.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If any of the passed arguments are null or emptyvoid setDisplayAttribute(AttributeDefinition displayAttribute)
displayAttribute
- the AttributeDefinition defining the attribute to be used as
display attribute.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullvoid setItemBuildScript(Document docStoreDoc)
docStoreDoc
- the post script document for this catalog
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullvoid setOrdered(boolean setOrdered)
setOrdered
- set true to allow ordering other wise false
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
void setPostSaveScript(Document docStoreDoc)
docStoreDoc
- the post script document for this catalog
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullvoid setPostScript(Document docStoreDoc)
docStoreDoc
- the post script document for this catalog
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullvoid setPreScript(Document docStoreDoc)
docStoreDoc
- the post script document for this catalog
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullvoid setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
attributeCollection
- the attribute collection.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.IllegalArgumentException
- If the passed argument is nullView createView(java.lang.String viewName)
viewName
- the name for the View
PIMInternalException
- if an internal error occurs, or the view already exists
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_EDIT_CATALOG_VIEWS
java.lang.IllegalArgumentException
- If the passed argument is null or emptyView getView(java.lang.String name)
name
- the name of the catalog View to retrieve
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- reserved for future use
java.lang.IllegalArgumentException
- If the passed argument is null or emptyjava.util.Collection<View> getViews()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- reserved for future useItemUserDefinedLog createUserDefinedLog(java.lang.String name, boolean runningLog)
name
- The log namerunningLog
- boolean. true if log is running false if not
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If name is null or if the name is an empty stringjava.util.Collection<ItemUserDefinedLog> getUserDefinedLogs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useItemUserDefinedLog getUserDefinedLog(java.lang.String name)
name
- The name of the ItemUserDefinedLog to be retrieved
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- If the name is null or if the name is an empty string
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |