|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Hierarchy
Interface for the Hierarchy object representing a Hierarchy of categories.
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
Category |
createCategory(java.lang.String parentCategoryPath,
java.lang.String delimiter,
java.lang.String pathValue)
Returns a new category object. |
Category |
createCategory(java.lang.String parentCategoryPath,
java.lang.String delimiter,
java.lang.String pathValue,
java.lang.String primaryKeyValue)
Returns a new category object. |
CategoryUserDefinedLog |
createUserDefinedLog(java.lang.String name,
boolean runningLog)
Creates a CategoryUserDefinedLog for this Hierarchy |
VersionInfo |
createVersion(java.lang.String name)
Create a new version of this Hierarchy |
View |
createView(java.lang.String viewName)
create a new empty View for this hierarchy |
Schedule |
deleteAsynchronous()
Schedules a delete of this hierarchy. |
void |
deleteCustomParameter(java.lang.String name)
Delete the custom parameter associated with the hierarchy. |
AccessControlGroup |
getAccessControlGroup()
Returns the Access Control Group for this hierarchy |
PIMCollection<Category> |
getCategories()
Retrieves a collection of all the Category objects in this hierarchy. |
PIMCollection<Category> |
getCategoriesAtLevel(int level)
Retrieves a collection of all the Category objects in this hierarchy residing at a particular level. |
PIMCollection<Category> |
getCategoriesByItemSecondarySpec(SecondarySpec spec)
Retrieves a collection of all the Category objects in this hierarchy implementing a particular secondary spec. |
java.util.Collection<Category> |
getCategoriesByPaths(java.util.Collection<java.lang.String> paths)
Retrieves a collection of all the Category objects in this hierarchy based upon their path names. |
java.util.Collection<Category> |
getCategoriesByPaths(java.util.Collection<java.lang.String> paths,
java.lang.String delimiter)
Retrieves a collection of all the Category objects in this hierarchy based upon their path names. |
PIMCollection<Category> |
getCategoriesByStandAloneSpec(SecondarySpec spec)
Retrieves a collection of all the Category objects in this hierarchy implementing a particular standalone spec. |
PIMCollection<Category> |
getCategoriesWithAttributeValue(java.lang.String attributeInstancePath,
java.lang.Object attributeValue)
Retrieves a collection of all the Category objects in this hierarchy based upon a particular attribute value. |
Document |
getCategoryBuildScript()
Retrieves the script document associated with an invocation point defined by the Hierarchy |
Category |
getCategoryByPath(java.lang.String path)
Retrieves a Category based upon Path name |
Category |
getCategoryByPath(java.lang.String path,
java.lang.String delimiter)
Retrieves a Category based upon Path name |
Category |
getCategoryByPrimaryKey(java.lang.String primaryKey)
Retrieves a Category based upon Primary key |
java.util.Collection<CategoryCollaborationArea> |
getCollaborationAreas()
Retrieve the collaboration areas associated with this hierarchy. |
java.util.Collection<java.lang.String> |
getCustomParameterNames()
Retrieves a list of user defined custom parameters present in this Hierarchy |
java.util.Collection<java.lang.String> |
getCustomParameterValues(java.lang.String name)
Retrieves the values of the given User Defined custom parameter for this Hierarchy |
AttributeDefinition |
getDisplayAttribute()
Returns the display attribute for this hierarchy |
java.lang.String |
getName()
Retrieves the name of this hierarchy. |
AttributeDefinition |
getPathAttribute()
Returns the path attribute for this hierarchy |
Document |
getPostSaveScript()
Retrieves the script document associated with an invocation point defined by the Hierarchy |
Document |
getPostScript()
Retrieves the script document associated with an invocation point defined by the Hierarchy |
Document |
getPreScript()
Retrieves the script document associated with an invocation point defined by the Hierarchy |
PrimarySpec |
getPrimarySpec()
Retrieves the Primary spec for this hierarchy. |
ProcessingOptions |
getProcessingOptions()
Provide temporary ways to change the default behavior for performance reasons. |
Category |
getRootCategory()
Returns the root category for this Hierarchy |
AttributeCollection |
getUserDefinedAttributeCollection()
Retrieves the User Defined Core Attribute Collection for this hierarchy |
CategoryUserDefinedLog |
getUserDefinedLog(java.lang.String name)
Retrieves a specific CategoryUserDefinedLog associated with this hierarchy with the specified name |
java.util.Collection<CategoryUserDefinedLog> |
getUserDefinedLogs()
Retrieves all CategoryUserDefinedLogs available in the current context for this Hierarchy |
View |
getView(java.lang.String name)
retrieve a View on this hierarchy by name |
java.util.Collection<View> |
getViews()
Retrieve all Views on this hierarchy. |
boolean |
isCategoryCheckedOut(java.lang.String categoryPrimaryKey)
Identifies if a category is checked out |
Schedule |
rollbackAsynchronous(VersionInfo version)
Schedules a rollback of this hierarchy. |
java.util.List<ValidationErrors> |
save()
Persist the changes to the given hierarchy object |
void |
setAccessControlGroup(AccessControlGroup acg)
Sets the Access Control Group for this hierarchy |
void |
setCategoryBuildScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Hierarchy |
void |
setCustomParameter(java.lang.String name,
java.lang.String value)
Sets a User Defined Custom Parameter for this Hierarchy. |
void |
setDisplayAttribute(AttributeDefinition attribute)
Set the attribute to be used as the display attribute for the hierarchy |
void |
setPostSaveScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Hierarchy |
void |
setPostScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Hierarchy |
void |
setPreScript(Document docStoreDoc)
Describes the location of a script with an invocation point defined by the Hierarchy |
void |
setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
Associate the User defined Attribute Collection with the hierarchy |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
Category createCategory(java.lang.String parentCategoryPath, java.lang.String delimiter, java.lang.String pathValue)
parentCategoryPath
- The path of the parent category excluding the root name.delimiter
- The delimiter used in the provided parent Path. The delimiter
consists of all characters in the delimiter string taken
together.pathValue
- The value for the path attribute of the category.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ADD_HIERARCHY_NODES
PIMInvalidPathException
- If the parent Path does not exist.
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter or pathValue
is emptyCategory createCategory(java.lang.String parentCategoryPath, java.lang.String delimiter, java.lang.String pathValue, java.lang.String primaryKeyValue)
parentCategoryPath
- The path of the parent category excluding the rootname.delimiter
- The delimiter used in the provided parent Path. The delimiter
consists of all characters in the delimiter string taken
together.pathValue
- The value for the path attribute of the category.primaryKeyValue
- Primary key value for the category
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ADD_HIERARCHY_NODES
PIMInvalidPathException
- If the parent Path does not exist.
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter, pathValue
or primaryKeyValue is emptyVersionInfo createVersion(java.lang.String name)
name
- The name of the version
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if name is null or emptySchedule deleteAsynchronous()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_DELETE
void deleteCustomParameter(java.lang.String name)
name
- Name of the custom parameter to be deleted
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if name is null or emptyAccessControlGroup getAccessControlGroup()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
PIMCollection<Category> getCategories()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
for more info
PIMCollection<Category> getCategoriesWithAttributeValue(java.lang.String attributeInstancePath, java.lang.Object attributeValue)
attributeInstancePath
- The Path of the attribute instanceattributeValue
- The Value of the attribute instance.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
PIMInvalidPathException
- If the given attribute path does not exist.
java.lang.IllegalArgumentException
- if any of the parameters is null, or if attributeInstancePath
is emptyfor more info
PIMCollection<Category> getCategoriesByItemSecondarySpec(SecondarySpec spec)
spec
- the item secondary spec implemented by the categories
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.for more info
PIMCollection<Category> getCategoriesAtLevel(int level)
level
- the level in the hierarchy for which categories to be
returned. Level 1 will return all the categories under root.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- If the passed in level is not a positive non-zero number.for more info
java.util.Collection<Category> getCategoriesByPaths(java.util.Collection<java.lang.String> paths)
paths
- Category paths excluding the root category name
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is nulljava.util.Collection<Category> getCategoriesByPaths(java.util.Collection<java.lang.String> paths, java.lang.String delimiter)
paths
- Category paths excluding the root category namedelimiter
- The delimiter used in the provided paths.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter is emptyPIMCollection<Category> getCategoriesByStandAloneSpec(SecondarySpec spec)
spec
- the standalone spec associated with the category.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.for more info
Document getCategoryBuildScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Category getCategoryByPath(java.lang.String path)
path
- category path excluding the root category name
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if path is nullCategory getCategoryByPath(java.lang.String path, java.lang.String delimiter)
path
- category path excluding the root category namedelimiter
- the delimiter used in the provided path.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is null or if delimiter is emptyCategory getCategoryByPrimaryKey(java.lang.String primaryKey)
primaryKey
- primary key
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if primaryKey is null or emptyjava.util.Collection<CategoryCollaborationArea> getCollaborationAreas()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<java.lang.String> getCustomParameterNames()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.util.Collection<java.lang.String> getCustomParameterValues(java.lang.String name)
name
- the name of the parameter
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if name is null or emptygetCustomParameterNames()
AttributeDefinition getDisplayAttribute()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.String getName()
PIMInternalException
- If an internal error occursAttributeDefinition getPathAttribute()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Document getPostSaveScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Document getPostScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Document getPreScript()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
PrimarySpec getPrimarySpec()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
Category getRootCategory()
PIMInternalException
- if an internal exception occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
AttributeCollection getUserDefinedAttributeCollection()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
ProcessingOptions getProcessingOptions()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ADD_HIERARCHY_NODES
Permission.HIERARCHY_DELETE_HIERARCHY_NODES
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_ATTRIBUTES
boolean isCategoryCheckedOut(java.lang.String categoryPrimaryKey)
categoryPrimaryKey
- the category primary key to search on
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
java.lang.IllegalArgumentException
- if any of the parameters is nullSchedule rollbackAsynchronous(VersionInfo version)
version
- the version of the hierarchy to use
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ROLLBACK
java.lang.IllegalArgumentException
- if any of the parameters is nulljava.util.List<ValidationErrors> save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
void setAccessControlGroup(AccessControlGroup acg)
acg
- The access control group to associate with a hierarchy
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void setCategoryBuildScript(Document docStoreDoc)
docStoreDoc
- the post script document for this hierarchy
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void setCustomParameter(java.lang.String name, java.lang.String value)
name
- the name of the parameter.value
- the value of the parameter
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null or if name is emptygetCustomParameterNames()
void setDisplayAttribute(AttributeDefinition attribute)
attribute
- an attribute
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void setPostSaveScript(Document docStoreDoc)
docStoreDoc
- the post script document for this hierarchy
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void setPostScript(Document docStoreDoc)
docStoreDoc
- the post script document for this hierarchy
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void setPreScript(Document docStoreDoc)
docStoreDoc
- the post script document for this hierarchy
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.void setUserDefinedAttributeCollection(AttributeCollection attributeCollection)
attributeCollection
- an attribute collection
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_ATTRIBUTES
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter that has not yet been
saved.View createView(java.lang.String viewName)
viewName
- the name for the View
PIMInternalException
- if an internal error occurs, or a view already exists by that
name
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_EDIT_HIERARCHY_VIEWS
java.lang.IllegalArgumentException
- if viewName is null or emptyView getView(java.lang.String name)
name
- the name of the hierarchy View to retrieve
PIMInternalException
- if an internal error occurs, or a view already exists by that
name
PIMAuthorizationException
- reserved for future use
java.lang.IllegalArgumentException
- if name is null or emptyjava.util.Collection<View> getViews()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- reserved for future useCategoryUserDefinedLog 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 the name is null or if the name is an empty stringjava.util.Collection<CategoryUserDefinedLog> getUserDefinedLogs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useCategoryUserDefinedLog getUserDefinedLog(java.lang.String name)
name
- The name of the CategoryUserDefinedLog 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 |