com.sapportals.wcm.service.actioninbox
Interface IActionInboxItem

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

All Superinterfaces:

IActionInboxNotification

public interface IActionInboxItem

extends IActionInboxNotification

The stored IActionInboxNotification object for a specific user.

Copyright 2004 SAP AG

Method Summary

void	delete(IResourceContext context) Delete the action item.
boolean	executeAction(IResourceContext context, IActionInboxAction action) Perform the given action for this item.
java.lang.String	getDescription(IResourceContext context) Provides a description for this action item's notification.
com.sapportals.portal.security.usermanagement.IUser	getDoneAuthor() Get the user, who was caused the 'done'.
java.lang.String	getDoneReason() Get the reason, why an item was set to done.
java.lang.String	getID() Get the unique ID for this item.
IActionInboxItemCategory	getItemCategory() Get the item category for this item.
java.util.Collection	getLinkedOwners(IResourceContext context) Get the list of owners for a linked action item.
java.util.Date	getModificationDate() Get the last modification date of this item.
com.sapportals.portal.security.usermanagement.IUMPrincipal	getOwner() Get the owner of this item.
java.lang.String	getProducerID() Get the id of the producer which once produced this item.
IResource	getResource(IResourceContext context) Get the resource associated to this item.
boolean	isDone() Check, if this item is in done state (setDone() has been called).
boolean	isLinked() Check, if this item is a linked item (an item that is stored as a multiple but crosslinked item in the inboxes for several users).
boolean	isRead() Check, if this item was already read by it's owner (setRead() has been called).
boolean	setDone(IResourceContext context, com.sapportals.portal.security.usermanagement.IUser reasonAuthor, java.lang.String reasonID) Set the 'done' state.
boolean	setRead(IResourceContext context) Set the 'read' state.

Methods inherited from interface com.sapportals.wcm.service.actioninbox.IActionInboxNotification

getAssignedRef, getAssignedRID, getCategoryID, getNotificationDate, getOriginator, getProperties

Method Detail

getID

public java.lang.String getID()

Get the unique ID for this item.

Returns:

a String with the unique ID for this item.

getDescription

public java.lang.String getDescription(IResourceContext context)

Provides a description for this action item's notification.

Parameters:

context - a IResourceContext with the context of the user to get the description for.

Returns:

a String with the description for this item's notification or null if the producer for this item is no longer registered.

getResource

public IResource getResource(IResourceContext context)
                      throws WcmException

Get the resource associated to this item.

Parameters:

context - the IResourceContext to use.

Returns:

a IResource with the associated resource.

getOwner

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

Get the owner of this item.

Returns:

a IUMPrincipal with the owner of this item.

Throws:

WcmException - if an error occured.

getItemCategory

public IActionInboxItemCategory getItemCategory()
                                         throws WcmException

Get the item category for this item.

Returns:

the IActionInboxItemCategory the item belongs to.

Throws:

WcmException - if an error occured.

getProducerID

public java.lang.String getProducerID()
                               throws WcmException

Get the id of the producer which once produced this item.

Returns:

a String with the item's producer id.

Throws:

WcmException - if an error occured.

getModificationDate

public java.util.Date getModificationDate()
                                   throws WcmException

Get the last modification date of this item.

Returns:

the Date of the timestamp when this item was last modified.

Throws:

WcmException - if an error occured.

isLinked

public boolean isLinked()
                 throws WcmException

Check, if this item is a linked item (an item that is stored as a multiple but crosslinked item in the inboxes for several users).

Returns:

a boolean true if the item is linked to others.

Throws:

WcmException - if an error occured.

getLinkedOwners

public java.util.Collection getLinkedOwners(IResourceContext context)
                                     throws WcmException

Get the list of owners for a linked action item.

Parameters:

context - the IResourceContext to use for accessing the inbox.

Returns:

a Collection of IUMPrincipals with the list of owners for linked items or null if this item is not linked.

Throws:

WcmException - if an error occured.

isRead

public boolean isRead()
               throws WcmException

Check, if this item was already read by it's owner (setRead() has been called).

Returns:

a boolean true if the item was set to 'read' state for it's owner, false if not.

Throws:

WcmException - if an error occured.

setRead

public boolean setRead(IResourceContext context)
                throws WcmException

Set the 'read' state.

Parameters:

context - the IResourceContext to use for accessing the inbox.

Returns:

a boolean true if the item was set to 'read' state, false if the item is in the wrong state for setting to 'read' (already done).

Throws:

WcmException - if an error occured.

isDone

public boolean isDone()
               throws WcmException

Check, if this item is in done state (setDone() has been called).

Returns:

a boolean true if the item was set to 'done' state, false if not.

Throws:

WcmException - if an error occured.

getDoneReason

public java.lang.String getDoneReason()
                               throws WcmException

Get the reason, why an item was set to done.

Returns:

a String with the reason id, null if no reason is available (e.g. if not in 'done' state).

Throws:

WcmException - if an error occured.

getDoneAuthor

public com.sapportals.portal.security.usermanagement.IUser getDoneAuthor()
                                                                  throws WcmException

Get the user, who was caused the 'done'.

Returns:

a IUser with the user who cause the 'done', null if not available (e.g. if the item is not in 'done' state).

Throws:

WcmException - if an error occured.

setDone

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

Set the 'done' state.

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.

Returns:

a boolean true if the item was set to 'done' state, false if the item is in the wrong state for setting to 'read' (already done).

Throws:

WcmException - if an error occured.

delete

public void delete(IResourceContext context)
            throws WcmException

Delete the action item.

Parameters:

context - the IResourceContext to use for accessing the inbox.

Throws:

WcmException - if an error occured.

executeAction

public boolean executeAction(IResourceContext context,
                             IActionInboxAction action)
                      throws WcmException

Perform the given action for this item.

Parameters:

context - the IResourceContext to performing the action for.

action - the IActionInboxAction to perform on this item.

Throws:

WcmException - if an error occured.