com.sapportals.wcm.service.actioninbox
Interface IActionInboxItemProducer

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

public interface IActionInboxItemProducer

A IActionInboxProducer sends IActionInboxNotifications to the action inbox.

Copyright 2004 SAP AG

Method Summary

boolean	executeItemAction(IResourceContext context, IActionInboxAction action, IActionInboxItem item) Execute an action for an item.
java.lang.String	getID() Get the unique ID of the producer.
java.lang.String	getItemDescription(IResourceContext context, IActionInboxItem item) Provides a description for the given item.
void	onDeleteItem(IActionInboxItem item) Notifiy about a deleted action inbox item.

Method Detail

getID

public java.lang.String getID()

Get the unique ID of the producer.

Returns:

a String with the unique ID for this producer.

getItemDescription

public java.lang.String getItemDescription(IResourceContext context,
                                           IActionInboxItem item)

Provides a description for the given item.

Parameters:

context - a IResourceContext with the locale of the preferred language to get the description for and the context of the current user to get the description for.

Returns:

a String with the description for the given item.

executeItemAction

public boolean executeItemAction(IResourceContext context,
                                 IActionInboxAction action,
                                 IActionInboxItem item)
                          throws WcmException

Execute an action for an item.

Parameters:

context - the IResourceContext with the user's context who triggered the execution of the action.

action - the IActionInboxAction to perform.

item - the IActionInboxItem to perform the action for.

Returns:

a boolean true if the action was performed, false if this action is not known by the producer.

Throws:

WcmException - if an error occured.

onDeleteItem

public void onDeleteItem(IActionInboxItem item)

Notifiy about a deleted action inbox item.

Parameters:

item - the IActionInboxItem which is about to be deleted.