|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Category
Interface for Category object (belongs to a Hierarchy, and groups Items)
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addChild(Category childCategory)
Adds a category as a child of this category. |
void |
addItemSecondarySpec(SecondarySpec spec,
boolean addToChildCategories,
boolean addAcrossMapping)
Associates a secondary item spec to this Category. |
void |
addItemSecondarySpec(SecondarySpec spec,
java.util.Collection<Catalog> catalogs,
boolean addToChildCategories,
boolean addAcrossMapping)
Associates a secondary item spec to this Category. |
void |
addSecondarySpec(SecondarySpec spec)
Associates a secondary spec defining this category’s attributes. |
void |
delete()
Deletes the given category. |
CollaborationObject |
getCheckedOutCategory(CategoryCollaborationArea categoryCollaborationArea)
Returns the CollaborationObject in the CollaborationArea corresponding to the given Category |
java.util.Collection<Category> |
getChildren()
Returns the categories immediately below this category. |
java.util.Collection<Category> |
getChildren(Catalog catalog,
boolean ordered,
boolean restrictToSubtreeWithItems)
Returns the categories immediately below this category. |
java.util.Collection<CollaborationArea> |
getCollaborationAreas()
Returns all the collaboration areas that this category is checked out to If the category is not checked out to any collaboration areas, an empty Collection will be returned. |
PIMCollection<Category> |
getDescendents()
Returns all the descendants of this category. |
java.lang.String |
getDisplayName()
Returns the name of this Category object |
java.util.Collection<java.lang.String> |
getFullPaths(boolean includeRootName)
Returns the full name paths of this Category. |
java.util.Collection<java.lang.String> |
getFullPaths(java.lang.String delimiter,
boolean includeRootName)
Returns the full name paths of this Category. |
Hierarchy |
getHierarchy()
Returns the Hierarchy object containing this Category object. |
PIMCollection<Item> |
getItems(Catalog catalog)
Returns the items associated with this category in the given catalog. |
PIMCollection<Item> |
getItems(Catalog catalog,
boolean ordered)
Returns the items associated with this category in the given catalog. |
java.util.Collection<SecondarySpec> |
getItemSecondarySpecs()
Returns the item secondary specs associated with this category. |
java.util.Collection<SecondarySpec> |
getItemSecondarySpecs(Catalog catalog)
Returns the item secondary specs associated with this category applied to items in the given catalog. |
int[] |
getLevels()
Returns the levels of this category in an array of Integers. |
java.util.Collection<Organization> |
getOrganizationsMappedTo()
Return a collection of Organizations this category is mapped to |
Category |
getParent()
Returns this category's parent. |
java.util.Collection<Category> |
getParents()
Returns the parent categories of the given Category. |
java.lang.String |
getPrimaryKey()
Return the primary key of this Category |
java.util.Collection<SecondarySpec> |
getSecondarySpecs()
Returns the secondary specs defining this category’s attributes. |
boolean |
hasChildren()
Determines if the given category has any children. |
boolean |
isCheckedOut()
Identifies if this category is checked to one or more collaboration areas |
boolean |
isRoot()
Identifies whether this Category is the root Category of the Hierarchy it lives within |
void |
mapToOrganization(Organization organization)
Maps this category to the given Organization |
void |
removeChild(Category childCategory)
Remove the given child Category from this category's children. |
void |
removeItemSecondarySpec(SecondarySpec spec)
Disassociates a secondary item spec to from this Category. |
void |
removeSecondarySpec(SecondarySpec spec)
Disassociates a secondary spec defining this category’s attributes. |
ValidationErrors |
validate()
Validates the category. |
Methods inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
getAttributeChangesComparedTo, getAttributeChangesSinceLastSave, getAttributeInstance, getAttributeValue, getRootAttributeInstance, getRootAttributeInstances, getSpecs, isComparable, setAttributeValue |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void addChild(Category childCategory)
childCategory
- the category to be added as a child
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_RECATEGORIZE_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.void addItemSecondarySpec(SecondarySpec spec, boolean addToChildCategories, boolean addAcrossMapping)
spec
- the secondary spec to be associatedaddToChildCategories
- if true, adds the item secondary spec to the child categories
as well. The spec is applied to the child categories on save
of the hierarchy.addAcrossMapping
- if true, adds the item secondary spec to the categories mapped
to this category. The spec is applied to the mapped categories
on save of the hierarchy.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_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 addItemSecondarySpec(SecondarySpec spec, java.util.Collection<Catalog> catalogs, boolean addToChildCategories, boolean addAcrossMapping)
spec
- the secondary spec to be associatedcatalogs
- list of catalogs to be affected by the specaddToChildCategories
- if true, adds the item secondary spec to the child categories
as well. The spec is applied to the child categories on save
of the category tree.addAcrossMapping
- if true, adds the item secondary spec to the categories mapped
to this category. The spec is applied to the mapped categories
on save of the category tree.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_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 addSecondarySpec(SecondarySpec spec)
spec
- the secondary spec to be associated
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_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 delete()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_DELETE_HIERARCHY_NODES
java.lang.UnsupportedOperationException
- if this is a root categoryCollaborationObject getCheckedOutCategory(CategoryCollaborationArea categoryCollaborationArea)
categoryCollaborationArea
- a collaboration area that this source object is checked out to
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.UnsupportedOperationException
- if the collaboration area is not one of those in
getCollaborationAreas() collection or if this object is not
checked out
java.lang.IllegalArgumentException
- if any of the parameters is nulljava.util.Collection<Category> getChildren()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- reserved for future usejava.util.Collection<Category> getChildren(Catalog catalog, boolean ordered, boolean restrictToSubtreeWithItems)
catalog
- the catalog to useordered
- If true and if the catalog supports ordering, then return the
child categories in catalog order.restrictToSubtreeWithItems
- If true, only return categories that have items in their
sub-trees.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have on the given catalog the equivalent
of
Permission.CATALOG_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.java.util.Collection<CollaborationArea> getCollaborationAreas()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.PIMCollection<Category> getDescendents()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- reserved for future usejava.util.Collection<java.lang.String> getFullPaths(boolean includeRootName)
includeRootName
- If true, the returned full paths include the root category
name.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<java.lang.String> getFullPaths(java.lang.String delimiter, boolean includeRootName)
delimiter
- The delimiter to be used in the full paths that are returned.includeRootName
- If true, the returned full paths include the root category
name.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operation
java.lang.IllegalArgumentException
- if delimiter is null or emptyPIMCollection<Item> getItems(Catalog catalog)
catalog
- The catalog whose items should be returned.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have on the given catalog the equivalent
of
Permission.CATALOG_VIEW_ITEMS
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.PIMCollection<Item> getItems(Catalog catalog, boolean ordered)
catalog
- The catalog whose items should be returned.ordered
- If true and if the catalog supports ordering, then the items
are returned in catalog order.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have on the given catalog the equivalent
of
Permission.CATALOG_VIEW_ITEMS
If the user does not have on the given catalog the equivalent
of
Permission.CATALOG_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.java.util.Collection<SecondarySpec> getItemSecondarySpecs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<SecondarySpec> getItemSecondarySpecs(Catalog catalog)
catalog
- the catalog
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
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.int[] getLevels()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useCategory getParent()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operation
java.lang.UnsupportedOperationException
- if this is a root categoryjava.util.Collection<Category> getParents()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user is not allowed to perform this operation
java.lang.UnsupportedOperationException
- if this is a root categoryjava.util.Collection<SecondarySpec> getSecondarySpecs()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useboolean hasChildren()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useboolean isCheckedOut()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useValidationErrors validate()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- reserved for future usevoid removeChild(Category childCategory)
childCategory
- the child category to remove.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have equivalent of
Permission.HIERARCHY_RECATEGORIZE_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.void removeItemSecondarySpec(SecondarySpec spec)
spec
- the secondary spec to be disassociated
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_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 removeSecondarySpec(SecondarySpec spec)
spec
- the secondary spec to be disassociated
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
Permission.HIERARCHY_MODIFY_HIERARCHY_NODE_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.java.util.Collection<Organization> getOrganizationsMappedTo()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid mapToOrganization(Organization organization)
organization
- object to map the category to
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Reserved for future use
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.java.lang.String getDisplayName()
PIMInternalException
- if an internal error occursHierarchy getHierarchy()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- Reserved for future useboolean isRoot()
PIMInternalException
- if an internal error occursjava.lang.String getPrimaryKey()
PIMInternalException
- if an internal error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |