org.kuali.rice.ken.deliverer.impl

Class KEWActionListMessageDeliverer

java.lang.Object

org.kuali.rice.ken.deliverer.impl.KEWActionListMessageDeliverer

All Implemented Interfaces:

NotificationMessageDeliverer

public class KEWActionListMessageDeliverer
extends Object
implements NotificationMessageDeliverer

This class is responsible for describing the default delivery mechanism for the system - the KEW Action List.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERNAL_COMMAND_FLAG Property set in the attribute content that indicates the action received by workflow was initiated by the Notification System itself (and not an end user)

Constructor Summary

Constructors

Constructor and Description
KEWActionListMessageDeliverer() Constructs a KEWActionListMessageDeliverer.java.

Method Summary

Methods

Modifier and Type	Method and Description
void	autoRemoveMessageDelivery(NotificationMessageDelivery messageDelivery) This implementation does an auto-remove by "canceling" the workflow document associated with the message delivery record.
void	deliverMessage(NotificationMessageDelivery messageDelivery) This implementation leverages the workflow integration services to push this notification into the KEW action list.
void	dismissMessageDelivery(NotificationMessageDelivery messageDelivery, String user, String cause) This method dismisses/removes the NotificationMessageDelivery so that it is no longer being presented to the user via this deliverer.
protected void	flagWorkflowDocument(WorkflowDocument doc) Marks the workflow document as originating from the Notification System, so that the Notification post-processor does not route the action back through the Notification System.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INTERNAL_COMMAND_FLAG

public static final String INTERNAL_COMMAND_FLAG

Property set in the attribute content that indicates the action received by workflow was initiated by the Notification System itself (and not an end user)

See Also:

Constant Field Values

Constructor Detail

KEWActionListMessageDeliverer

public KEWActionListMessageDeliverer()

Constructs a KEWActionListMessageDeliverer.java.

Method Detail

deliverMessage

public void deliverMessage(NotificationMessageDelivery messageDelivery)
                    throws NotificationMessageDeliveryException

This implementation leverages the workflow integration services to push this notification into the KEW action list.

Specified by:

deliverMessage in interface NotificationMessageDeliverer

Parameters:

messageDelivery - The messageDelivery to process

Throws:

NotificationMessageDeliveryException

See Also:

NotificationMessageDeliverer.deliverMessage(org.kuali.rice.ken.bo.NotificationMessageDelivery)

autoRemoveMessageDelivery

public void autoRemoveMessageDelivery(NotificationMessageDelivery messageDelivery)
                               throws NotificationAutoRemoveException

This implementation does an auto-remove by "canceling" the workflow document associated with the message delivery record. This prevents the user from seeing the item in their list anymore.

Specified by:

autoRemoveMessageDelivery in interface NotificationMessageDeliverer

Parameters:

messageDelivery - The messageDelivery to auto remove

Throws:

NotificationAutoRemoveException

See Also:

NotificationMessageDeliverer.autoRemoveMessageDelivery(org.kuali.rice.ken.bo.NotificationMessageDelivery)

dismissMessageDelivery

public void dismissMessageDelivery(NotificationMessageDelivery messageDelivery,
                          String user,
                          String cause)

Description copied from interface: NotificationMessageDeliverer

This method dismisses/removes the NotificationMessageDelivery so that it is no longer being presented to the user via this deliverer. Note, whether this action is meaningful is dependent on the deliverer implementation. If the deliverer cannot control the presentation of the message, then this method need not do anything.

Specified by:

dismissMessageDelivery in interface NotificationMessageDeliverer

Parameters:

messageDelivery - the messageDelivery to dismiss

cause - the reason the message was dismissed

See Also:

NotificationMessageDeliverer.dismissMessageDelivery(org.kuali.rice.ken.bo.NotificationMessageDelivery, java.lang.String, java.lang.String)

flagWorkflowDocument

protected void flagWorkflowDocument(WorkflowDocument doc)

Marks the workflow document as originating from the Notification System, so that the Notification post-processor does not route the action back through the Notification System.

Parameters:

doc - the doc to monogram