com.sapportals.wcm.service.actioninbox
Interface IActionInboxItemCategory

[contained in: com.sap.km.cm.service.base.par - km.shared.service.actioninbox_api.jar]

public interface IActionInboxItemCategory

A IActionInboxItemCategory is a representation of a specific user's inbox folder for a category.
All IActionInboxItems belong to an item category. A item category belongs to a category.

Copyright 2004 SAP AG

Method Summary

IActionInboxItem	createItem(IResourceContext context, IActionInboxItemProducer producer, IActionInboxNotification notification, java.lang.String linkID) Create a new item in the item category.
IActionInboxCategory	getCategory() Get the category for this item category.
java.lang.String	getID() Get the unique ID of the action category.
IActionInboxItem	getItem(IResourceContext context, java.lang.String itemID) Get a specific item.
IActionInboxItemList	getItems(IResourceContext context) Get a list with the available items for this item category.
IActionInboxItemList	getItems(IResourceContext context, boolean withUnread, boolean withRead, boolean withDone) Get a list with the available items for this item category for a given state.
IActionInboxItemList	getItemsTop(IResourceContext context, boolean withUnread, boolean withRead, boolean withDone, int topNumber) Get a list with the available items for this item category for a given state.
IActionInboxItemList	getItemsTop(IResourceContext context, int topNumber) Get a list with the available items for this item category depending on certain parameters.
IActionInboxItemList	getItemsTop(IResourceContext context, int topNumber, int depth, java.lang.String sortedBy, boolean ascending) Get a list with the available items for this item category depending on certain parameters.
java.lang.String	getLinkID() Get a link ID to crosslink items across several item categories.
com.sapportals.portal.security.usermanagement.IUMPrincipal	getOwner() Get the owner of this item category.
IResource	getResource(IResourceContext context) Get the resource associated to this item category.
void	setItemsReadForCategory(IResourceContext context)

Method Detail

getID

public java.lang.String getID()

Get the unique ID of the action category.

Returns:

a String with the unique ID for this category.

getResource

public IResource getResource(IResourceContext context)
                      throws WcmException

Get the resource associated to this item category.

Parameters:

context - the IResourceContext to use.

Returns:

a IResource with the associated resource.

getCategory

public IActionInboxCategory getCategory()
                                 throws WcmException

Get the category for this item category.

Returns:

a IActionInboxCategory with the category for this item category.

Throws:

a - WcmException if an error occurred.

getOwner

public com.sapportals.portal.security.usermanagement.IUMPrincipal getOwner()
                                                                    throws WcmException

Get the owner of this item category.

Returns:

a IUMPrincipal with the owner of this item category.

Throws:

a - WcmException if an error occurred.

getItems

public IActionInboxItemList getItems(IResourceContext context)
                              throws WcmException

Get a list with the available items for this item category.

Parameters:

context - the IResourceContext to use for accessing the inbox.

Returns:

a IActionInboxItemList with all items for this item category.

Throws:

a - WcmException if an error occurred.

getItems

public IActionInboxItemList getItems(IResourceContext context,
                                     boolean withUnread,
                                     boolean withRead,
                                     boolean withDone)
                              throws WcmException

Get a list with the available items for this item category for a given state.

Parameters:

context - the IResourceContext to use for accessing the inbox.

withUnread - a boolean true if unread items should be included

withRead - a boolean true if read items should be included

withDone - a boolean true if done items should be included

Returns:

a IActionInboxItemList with all items for this item category and the specified state.

Throws:

a - WcmException if an error occurred.

getItem

public IActionInboxItem getItem(IResourceContext context,
                                java.lang.String itemID)
                         throws WcmException

Get a specific item.

Parameters:

context - the IResourceContext to use for accessing the inbox.

itemID - the String with the id of the IActionInboxItem to get.

Returns:

the IActionInboxItem for the given id or null if not found.

Throws:

a - WcmException if an error occurred.

getLinkID

public java.lang.String getLinkID()
                           throws WcmException

Get a link ID to crosslink items across several item categories.

Returns:

a String with a unique link ID.

Throws:

a - WcmException if an error occurred.

createItem

public IActionInboxItem createItem(IResourceContext context,
                                   IActionInboxItemProducer producer,
                                   IActionInboxNotification notification,
                                   java.lang.String linkID)
                            throws WcmException

Create a new item in the item category.

Parameters:

context - the IResourceContext to use for accessing the inbox.

producer - the IActionInboxProducer wich will provide the actions allowed for this item. This producer has to be a registered item producer - if not, an exception will be thrown!

notification - the IActionInboxNotification to store in the inbox category.

linkID - a String with a common link ID to crosslink several items from other item categories to this item or null if no other items are linked.

Returns:

the IActionInboxItem saved.

Throws:

a - WcmException if an error occurred.

getItemsTop

public IActionInboxItemList getItemsTop(IResourceContext context,
                                        int topNumber)
                                 throws WcmException

Get a list with the available items for this item category depending on certain parameters.

Parameters:

context - the IResourceContext to use for accessing the inbox.

topNumber - an int that allows to limit the number of items to query for. If this value is -1 then all items are retrieved

topNumber - an int that allows to limit the number of items

Returns:

a IActionInboxItemList with all items for this item category.

Throws:

a - WcmException if an error occurred.

getItemsTop

public IActionInboxItemList getItemsTop(IResourceContext context,
                                        int topNumber,
                                        int depth,
                                        java.lang.String sortedBy,
                                        boolean ascending)
                                 throws WcmException

Get a list with the available items for this item category depending on certain parameters.

Parameters:

context - the IResourceContext to use for accessing the inbox.

topNumber - an int that allows to limit the number of items to query for. If this value is -1 then all items are retrieved

topNumber - an int that allows to limit the number of items to query for. If this value is -1 then all items are retrieved

depth - an int that allows to tune the retrieval of items when aib migration process take places. Only migration process should use this parameter. If no migration is required(normal case) this value should be equals to -1.

sortedBy - a String Specify a AIB feature to be used to order the list. If default order is to be used, just value it as empty string.

ascending - a boolean true to specify in which order we want the items.

Returns:

a IActionInboxItemList with all items for this item category and the specified state.

Throws:

a - WcmException if an error occurred.

getItemsTop

public IActionInboxItemList getItemsTop(IResourceContext context,
                                        boolean withUnread,
                                        boolean withRead,
                                        boolean withDone,
                                        int topNumber)
                                 throws WcmException

Get a list with the available items for this item category for a given state.

Parameters:

context - the IResourceContext to use for accessing the inbox.

withUnread - a boolean true if unread items should be included

withRead - a boolean true if read items should be included

withDone - a boolean true if done items should be included

topNumber - an int that allows to limit the number of items to query for. If this value is -1 then all items are retrieved

Returns:

a IActionInboxItemList with all items for this item category and the specified state.

Throws:

a - WcmException if an error occurred.

setItemsReadForCategory

public void setItemsReadForCategory(IResourceContext context)
                             throws WcmException