|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Item
Represents the Item object in the system.
Nested Class Summary | |
---|---|
static class |
Item.SaveResult
Describes the Item Status after a Save operation |
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addToCategory(Category category)
Add an item to a category. |
void |
delete()
Deletes the item |
Catalog |
getCatalog()
Returns the catalog to which this item belongs. |
java.util.Collection<Category> |
getCategories()
Returns all the categories to which this item belongs. |
java.util.Collection<Category> |
getCategories(Hierarchy hierarchy)
Returns all the categories of the Hierarchy which is passed in, to which this item belongs. |
CollaborationItem |
getCheckedOutItem(ItemCollaborationArea itemCollaborationArea)
Returns the item's collaboration object in the collaboration area that the item is checked out to. |
java.util.Collection<CollaborationArea> |
getCollaborationAreas()
Returns the collaboration areas that the item is checked out to. |
java.lang.String |
getDisplayName()
Returns the display name. |
java.util.Collection<Item> |
getLinkedItems()
Retrieves all of the Items that are linked to this item's primary key. |
java.util.Collection<Hierarchy> |
getLocationHierarchies()
Returns all the location hierarchies which are available on this catalog for this item, regardless of whether it has stored any data in them. |
java.util.Collection<Organization> |
getOrganizationsMappedTo()
Return a collection of all Organizations this item is mapped to |
java.lang.String |
getPrimaryKey()
Returns the primary key. |
PIMCollection<Item> |
getRelatedItems(Catalog filter,
boolean toOrFrom)
Retrieves all of the Items that this item is connected to via a relationship link on other items. |
Item.SaveResult |
getSaveResult()
Returns an enumeration of the net effect of the last save on this item. |
java.lang.String |
getXMLRepresentation(Spec spec,
boolean includePrimaryKeyValue,
boolean addNameSpace,
java.util.Collection<java.util.Locale> locales,
java.util.Collection<AttributeCollection> attrGroups)
Returns the XML Representation for the particular item. |
java.lang.String |
getXMLRepresentation(Spec spec,
boolean includePrimaryKeyValue,
boolean addNameSpace,
java.util.Collection<java.util.Locale> locales,
java.util.Collection<AttributeCollection> attrGroups,
java.lang.String dateFormat)
Returns the XML Representation for the particular item. |
boolean |
isCheckedOut()
Determines if the item is checked out to a collaboration area. |
void |
mapToCategory(Category category)
Map an item to a category. |
void |
mapToOrganization(Organization organization)
Maps this item to the given Organization |
void |
moveToCategories(java.util.Collection<Category> categories)
Move item from existing categories to new set of categories. |
void |
moveToCategoriesWithMapping(java.util.Collection<Category> categories)
This method behaves exactly like Item.moveToCategories(Collection |
void |
removeFromCategory(Category category)
Remove an item from a category. |
ExtendedValidationErrors |
save()
Saves the item. |
void |
setCategorySpecificAttributeProcessing(boolean setEnabled)
Set whether or not category specific attributes should be processed for the item Default would be true to process them |
void |
setPrimaryKey(java.lang.String primaryKey)
Sets the primary key. |
ExtendedValidationErrors |
validate()
Validates the item. |
Methods inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
getAttributeChangesComparedTo, getAttributeInstance, getAttributeValue, getRootAttributeInstance, getRootAttributeInstances, getSpecs, isComparable, setAttributeValue |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void addToCategory(Category category)
category
- Must be one which belongs to a hierarchy contained by the
catalog which contains the item.
If the item was already mapped to the category then no change will take place.
java.lang.IllegalArgumentException
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void delete()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_DELETE_ITEMS
java.util.Collection<Item> getLinkedItems()
Permission.CATALOG_VIEW_ITEMS
PIMInternalException
- If an internal error occursPIMCollection<Item> getRelatedItems(Catalog filter, boolean toOrFrom)
filter
- A catalog which contains the items that contain a relationship
link to or from this itemtoOrFrom
- If true only items in the filter catalog that have a
relationship link to this item are returned. If false only
items in the filter catalog that have a relationship link from
this item are returned.
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_VIEW_ITEMS
for more info
Catalog getCatalog()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_LIST
java.util.Collection<Category> getCategories()
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
Collection
of Category
to which
this item belongs. If the item does not belong to any categories
(in other words, it is unassigned), then an empty
Collection
is returned.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- reserved for future usejava.util.Collection<Category> getCategories(Hierarchy hierarchy)
Collection
of Category
of the Hierarchy
to which this item belongs. If the item does not belong to any categories
(in other words, it is unassigned), then an empty Collection
is returned.
PIMInternalException
- If an internal error occurs.
java.lang.IllegalArgumentException
- If the hierarchy argument is null
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.HIERARCHY_VIEW_HIERARCHY_NODES
CollaborationItem getCheckedOutItem(ItemCollaborationArea itemCollaborationArea)
itemCollaborationArea
- -
a collaboration area that this source object is checked out to
java.lang.UnsupportedOperationException
- If the collaboration area is not one of those in
getCollaborationAreas() collection or if this object is not
checked out.java.util.Collection<CollaborationArea> getCollaborationAreas()
java.lang.String getDisplayName()
PIMInternalException
- If an internal error occurs.java.util.Collection<Organization> getOrganizationsMappedTo()
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the user is not authorizedjava.lang.String getPrimaryKey()
PIMInternalException
- If an internal error occurs.Item.SaveResult getSaveResult()
PIMInternalException
- If an internal error occurs.boolean isCheckedOut()
ExtendedValidationErrors validate()
PIMInternalException
- If an internal error occurs.void mapToCategory(Category category) throws PIMInvalidOperationException
category
- -
The category to map the item to.
PIMInternalException
- If an internal error occurs
PIMInvalidOperationException
- If map is not allowed by category
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void mapToOrganization(Organization organization)
organization
- -
The Organization object to map the item to
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- if the user is not authorizedvoid moveToCategories(java.util.Collection<Category> categories)
categories
- -
the categories to move the item to.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
java.lang.IllegalArgumentException
- If the categories argument is nullvoid moveToCategoriesWithMapping(java.util.Collection<Category> categories)
categories
- -
collection of categories to move the item to.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
java.lang.IllegalArgumentException
- If the categories argument is nullvoid removeFromCategory(Category category)
category
- -
There will be no effect if the item does not belong to the
given category.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
ExtendedValidationErrors save()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void setCategorySpecificAttributeProcessing(boolean setEnabled)
setEnabled
- To process them (default) or false to ignore processing them
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void setPrimaryKey(java.lang.String primaryKey)
primaryKey
- -
The primary key
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
java.lang.IllegalArgumentException
- If the primary key argument is nulljava.util.Collection<Hierarchy> getLocationHierarchies()
Permission.HIERARCHY_LIST
Collection
of Hierarchy
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_ATTRIBUTES
java.lang.String getXMLRepresentation(Spec spec, boolean includePrimaryKeyValue, boolean addNameSpace, java.util.Collection<java.util.Locale> locales, java.util.Collection<AttributeCollection> attrGroups)
spec
- -
The Spec.includePrimaryKeyValue
- -
Flag to determine whether to include Primary Key.addNameSpace
- -
TFlag to determine whether to add name space.locales
- -
Collection of Locales.attrGroups
- -
Collection of Attribute Collections.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalStateException
- if the object is not in a stable persisted state.
java.lang.IllegalArgumentException
- if argument passed is null.java.lang.String getXMLRepresentation(Spec spec, boolean includePrimaryKeyValue, boolean addNameSpace, java.util.Collection<java.util.Locale> locales, java.util.Collection<AttributeCollection> attrGroups, java.lang.String dateFormat)
spec
- -
The Spec.includePrimaryKeyValue
- -
Flag to determine whether to include Primary Key.addNameSpace
- -
Flag to determine whether to add name space.dateFormat
- -
The value of Spec Nodes whose type is Date, will be formatted using the
date format provided.locales
- -
Collection of Locales.attrGroups
- -
Collection of Attribute Collections.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use.
java.lang.IllegalStateException
- if the object is not in a stable persisted state.
java.lang.IllegalArgumentException
- if argument passed is null or empty.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |