com.sapportals.wcm.service.actioninbox
Interface IActionInboxService

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

All Superinterfaces:

IService

public interface IActionInboxService

extends IService

The IActionInboxService stores IActionInboxNotificationss grouped by IActionInboxCategory as IActionInboxItems into IActionInboxItemCategorys.
A IActionInboxCategory represents the different types of the IActionInboxNotifications. The IActionInboxNotifications are like 'semantic events' which are send by the IActionInboxItemProducers. A IActionInboxNotification is stored as an ActionInboxItem in a user's IActionInboxItemCategory.

Copyright 2004 SAP AG

Method Summary

IActionInboxItemList	deleteItems(IActionInboxItemProducer producer, java.lang.String categoryID, java.lang.String[] itemIDs) Delete several existing action inbox items.
IActionInboxItemList	deleteItems(IResourceContext context, IActionInboxItemList items) Delete several existing action inbox items.
IActionInboxItemList	executeItemActions(IResourceContext context, java.lang.String actionName, IActionInboxItemList items) execute an action on several existing action inbox items.
IActionInboxCategoryList	getCategories() Get the categories.
IActionInboxCategory	getCategory(java.lang.String categoryID) Get a specific category by id.
IActionInboxItemCategoryList	getItemCategories(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner) Get all item categories for a specific user/group/role.
IActionInboxItemCategoryList	getItemCategories(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner, java.lang.String[] categoryIDs) Get specific item categories for a specific user/group/role.
IActionInboxItemCategory	getItemCategory(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner, IActionInboxCategory category) Get a specific item category for a specific user/group/role.
IActionInboxItemCategory	getItemCategory(IResourceContext context, com.sapportals.portal.security.usermanagement.IUMPrincipal owner, java.lang.String categoryID) Get a specific item category for a specific user/group/role.
IActionInboxItemList	getItemsFromIDs(IResourceContext context, java.lang.String categoryID, com.sapportals.portal.security.usermanagement.IUMPrincipal owner, java.lang.String[] itemIDs) Get a list of items for a given array of ids.
IActionInboxCategory	registerProducer(IActionInboxItemProducer itemProducer, java.lang.String categoryID) Register an item producer to a category at the IActionInboxService.
IActionInboxItemList	send(java.util.Collection recipients, IActionInboxItemProducer producer, IActionInboxNotification notification) Store a notification in several user/group/role's inboxes for a given category as several items (same as send(recipients, producer, notification, false)).
IActionInboxItemList	send(java.util.Collection recipients, IActionInboxItemProducer producer, IActionInboxNotification notification, boolean isLinked) Store a notification in several user/group/role's inboxes for a given category.
IActionInboxItemList	send(com.sapportals.portal.security.usermanagement.IUMPrincipal recipient, IActionInboxItemProducer producer, IActionInboxNotification notification) Store a notification in a user/group/role's inbox for a given category.
IActionInboxItemList	sendToUsers(java.util.Collection recipients, IActionInboxItemProducer producer, IActionInboxNotification notification, boolean isLinked) Store a notification in several user's inboxes for a given category.
IActionInboxItemList	sendToUsers(com.sapportals.portal.security.usermanagement.IUMPrincipal recipient, IActionInboxItemProducer producer, IActionInboxNotification notification, boolean isLinked) Store a notification in a user's inbox for a given category.
IActionInboxItemList	setItemsDone(IActionInboxItemProducer producer, java.lang.String categoryID, com.sapportals.portal.security.usermanagement.IUser reasonAuthor, java.lang.String reasonID, java.lang.String[] itemIDs) Set several existing action inbox items to 'done'.
IActionInboxItemList	setItemsDone(IResourceContext context, com.sapportals.portal.security.usermanagement.IUser reasonAuthor, java.lang.String reasonID, IActionInboxItemList items) Set several existing action inbox items to 'done'.
IActionInboxItemList	setItemsRead(IResourceContext context, IActionInboxItemList items) Set several existing action inbox items to 'read'.
void	setItemsReadForCategory(IResourceContext context, IActionInboxItemCategory category)

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Method Detail

registerProducer

public IActionInboxCategory registerProducer(IActionInboxItemProducer itemProducer,
                                             java.lang.String categoryID)
                                      throws WcmException

Register an item producer to a category at the IActionInboxService.

Parameters:

itemProducer - the IActionInboxItemProducer to register.

categoryID - the String of the category's id, for which the producer will produce items.

Returns:

the IActionInboxCategory the producer registered to.

Throws:

WcmException - if an error occured.

getCategories

public IActionInboxCategoryList getCategories()
                                       throws WcmException

Get the categories.

Returns:

a IActionInboxCategoryList of categories.

Throws:

a - WcmException if an error occurred.

getCategory

public IActionInboxCategory getCategory(java.lang.String categoryID)
                                 throws WcmException

Get a specific category by id.

Parameters:

categoryID - the String with the desired category's id.

Returns:

a IActionInboxCategory for the given id.

Throws:

a - WcmException if an error occurred.

getItemCategories

public IActionInboxItemCategoryList getItemCategories(IResourceContext context,
                                                      com.sapportals.portal.security.usermanagement.IUMPrincipal owner)
                                               throws WcmException

Get all item categories for a specific user/group/role.

Parameters:

context - the IResourceContext to use for accessing the inbox.

owner - the IUMPrincipal of the user/group/role to get the inbox for.

Returns:

a IActionInboxItemCategoryList with the inbox categories for the given user/group/role. If the specified owner is not a user, the list will contain only those groups which are not for users only.

Throws:

a - WcmException if an error occurred.

getItemCategories

public IActionInboxItemCategoryList getItemCategories(IResourceContext context,
                                                      com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
                                                      java.lang.String[] categoryIDs)
                                               throws WcmException

Get specific item categories for a specific user/group/role.

Parameters:

context - the IResourceContext to use for accessing the inbox.

owner - the IUMPrincipal of the user/group/role to get the inbox for.

categoryIDs - an array of Strings with the ids of the desired categories.

Returns:

a IActionInboxItemCategoryList with the inbox categories for the given user/group/role and ids. If the specified owner is not a user, the list will contain only those groups which are not for users only.

Throws:

a - WcmException if an error occurred.

getItemCategory

public IActionInboxItemCategory getItemCategory(IResourceContext context,
                                                com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
                                                IActionInboxCategory category)
                                         throws WcmException

Get a specific item category for a specific user/group/role.

Parameters:

context - the IResourceContext to use for accessing the inbox.

owner - the IUMPrincipal of the user/group/role to get the inbox for.

category - the IActionInboxCategory with the category of the item category to get.

Returns:

a IActionInboxItemCategory with the inbox category for the given user/group/role and id. Is null if the specified owner is not a user but the requested category is for users only.

Throws:

a - WcmException if an error occurred.

getItemCategory

public IActionInboxItemCategory getItemCategory(IResourceContext context,
                                                com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
                                                java.lang.String categoryID)
                                         throws WcmException

Get a specific item category for a specific user/group/role.

Parameters:

context - the IResourceContext to use for accessing the inbox.

owner - the IUMPrincipal of the user/group/role to get the inbox for.

categoryID - the String with the desired category's id.

Returns:

a IActionInboxItemCategory with the inbox category for the given user/group/role and id. Is null if the specified owner is not a user but the requested category is for users only.

Throws:

a - WcmException if an error occurred.

getItemsFromIDs

public IActionInboxItemList getItemsFromIDs(IResourceContext context,
                                            java.lang.String categoryID,
                                            com.sapportals.portal.security.usermanagement.IUMPrincipal owner,
                                            java.lang.String[] itemIDs)
                                     throws WcmException

Get a list of items for a given array of ids.

Parameters:

context - the IResourceContext to use for accessing the inbox.

categoryID - a String with the id of the category to get the items for.

owner - the IUMPrincipal of the user/group/role to get the inbox items for.

Returns:

a IActionInboxItemList with the list of items for the given ids.

Throws:

a - WcmException if an error occurred.

send

public IActionInboxItemList send(com.sapportals.portal.security.usermanagement.IUMPrincipal recipient,
                                 IActionInboxItemProducer producer,
                                 IActionInboxNotification notification)
                          throws WcmException

Store a notification in a user/group/role's inbox for a given category. If the category is for users only, the recipient will be automatically resolved, if it's not a user.

Parameters:

recipient - a IUMPrincipal with the owner to send the notification to.

producer - a IActionInboxItemProducer with the producer of this notification.

notification - the IActionInboxNotification to store.

Returns:

a IActionInboxItemLists with the succesfully sent items (might be more than one, if the recipient is not a user and the category is for users only).

Throws:

WcmException - if an error occured.

send

public IActionInboxItemList send(java.util.Collection recipients,
                                 IActionInboxItemProducer producer,
                                 IActionInboxNotification notification)
                          throws WcmException

Store a notification in several user/group/role's inboxes for a given category as several items (same as send(recipients, producer, notification, false)). If the category is for users only, recipients which are not users will be automatically resolved.

Parameters:

recipients - a Collection of IUMPrincipals with the users/roles/groups to send the notification to.

producer - a IActionInboxItemProducer with the producer of this notification.

notification - the IActionInboxNotification to store.

Returns:

a IActionInboxItemLists with the succesfully sent items.

Throws:

WcmException - if an error occured.

send

public IActionInboxItemList send(java.util.Collection recipients,
                                 IActionInboxItemProducer producer,
                                 IActionInboxNotification notification,
                                 boolean isLinked)
                          throws WcmException

Store a notification in several user/group/role's inboxes for a given category. If the category is for users only, recipients which are not users will be automatically resolved.

Parameters:

recipients - a Collection of IUMPrincipals with the users/roles/groups to send the notification to.

producer - a IActionInboxItemProducer with the producer of this notification.

notification - the IActionInboxNotification to store.

isLinked - a boolean true, if the notification should be treated as a linked notification, false if not (each notification is a separate item).

Returns:

a IActionInboxItemLists with the succesfully sent items.

Throws:

WcmException - if an error occured.

sendToUsers

public IActionInboxItemList sendToUsers(com.sapportals.portal.security.usermanagement.IUMPrincipal recipient,
                                        IActionInboxItemProducer producer,
                                        IActionInboxNotification notification,
                                        boolean isLinked)
                                 throws WcmException

Store a notification in a user's inbox for a given category. If the recipient is not a user, the group/role is resolved and the item is saved in the inboxes of the user's belonging to this group/role.

Parameters:

recipients - a IUMPrincipal with the user/role/group to send the notification to.

producer - a IActionInboxItemProducer with the producer of this notification.

notification - the IActionInboxNotification to store.

isLinked - a boolean true, if the notification should be treated as a linked notification, false if not (each notification is a separate item).

Returns:

a IActionInboxItemLists with the succesfully sent items.

Throws:

WcmException - if an error occured.

sendToUsers

public IActionInboxItemList sendToUsers(java.util.Collection recipients,
                                        IActionInboxItemProducer producer,
                                        IActionInboxNotification notification,
                                        boolean isLinked)
                                 throws WcmException

Store a notification in several user's inboxes for a given category. If a recipient is not a user, the group/role is resolved and the item is saved in the inboxes of the user's belonging to this group/role.

Parameters:

recipients - a Collection of IUMPrincipals with the users/roles/groups to send the notification to.

producer - a IActionInboxItemProducer with the producer of this notification.

notification - the IActionInboxNotification to store.

isLinked - a boolean true, if the notification should be treated as a linked notification, false if not (each notification is a separate item).

Returns:

a IActionInboxItemLists with the succesfully sent items.

Throws:

WcmException - if an error occured.

setItemsDone

public IActionInboxItemList setItemsDone(IActionInboxItemProducer producer,
                                         java.lang.String categoryID,
                                         com.sapportals.portal.security.usermanagement.IUser reasonAuthor,
                                         java.lang.String reasonID,
                                         java.lang.String[] itemIDs)
                                  throws WcmException

Set several existing action inbox items to 'done'.

Parameters:

producer - a IActionInboxItemProducer with the producer of this notification.

categoryID - the String with the desired category's id.

reasonAuthor - a IUser with the user who caused the 'done' state.

reasonID - a String with a reason code.

itemIDs - an array of Strings with the ids of the IActionInboxItem to set to 'done'.

Returns:

a IActionInboxItemLists with the set items.

Throws:

WcmException - if an error occured.

setItemsRead

public IActionInboxItemList setItemsRead(IResourceContext context,
                                         IActionInboxItemList items)
                                  throws WcmException

Set several existing action inbox items to 'read'.

Parameters:

context - the IResourceContext to use for accessing the inbox.

itemIDs - an array of Strings with the ids of the IActionInboxItem to set to 'read'.

Returns:

a IActionInboxItemLists with the set items.

Throws:

WcmException - if an error occured.

setItemsDone

public IActionInboxItemList setItemsDone(IResourceContext context,
                                         com.sapportals.portal.security.usermanagement.IUser reasonAuthor,
                                         java.lang.String reasonID,
                                         IActionInboxItemList items)
                                  throws WcmException

Set several existing action inbox items to 'done'.

Parameters:

context - the IResourceContext to use for accessing the inbox.

reasonAuthor - a IUser with the user who caused the 'done' state.

reasonID - a String with a reason code.

itemIDs - an array of Strings with the ids of the IActionInboxItem to set to 'done'.

Returns:

a IActionInboxItemLists with the set items.

Throws:

WcmException - if an error occured.

deleteItems

public IActionInboxItemList deleteItems(IActionInboxItemProducer producer,
                                        java.lang.String categoryID,
                                        java.lang.String[] itemIDs)
                                 throws WcmException

Delete several existing action inbox items.

Parameters:

producer - a IActionInboxItemProducer with the producer of this notification.

categoryID - the String with the desired category's id.

itemIDs - an array of Strings with the ids of the IActionInboxItem to set to 'done'.

Returns:

a IActionInboxItemLists with the deleted items.

Throws:

WcmException - if an error occured.

deleteItems

public IActionInboxItemList deleteItems(IResourceContext context,
                                        IActionInboxItemList items)
                                 throws WcmException

Delete several existing action inbox items.

Parameters:

context - the IResourceContext to use for accessing the inbox.

itemIDs - an array of Strings with the ids of the IActionInboxItem to delete.

Returns:

a IActionInboxItemLists with the deleted items.

Throws:

WcmException - if an error occured.

executeItemActions

public IActionInboxItemList executeItemActions(IResourceContext context,
                                               java.lang.String actionName,
                                               IActionInboxItemList items)
                                        throws WcmException

execute an action on several existing action inbox items.

Parameters:

context - the IResourceContext to use for accessing the inbox.

actionName - a String with the name of the action to excute. The name has to exist in all of the categories the specified items in the array belong to.

itemIDs - an array of Strings with the ids of the IActionInboxItem to execute the action for.

Returns:

a IActionInboxItemLists> with the items the action has been executed for.

Throws:

WcmException - if an error occured.

setItemsReadForCategory

public void setItemsReadForCategory(IResourceContext context,
                                    IActionInboxItemCategory category)
                             throws WcmException