Package org.kuali.rice.kcb.deliverer.impl

Class MockMessageDeliverer

java.lang.Object

org.kuali.rice.kcb.deliverer.impl.MockMessageDeliverer

All Implemented Interfaces:

MessageDeliverer

public class MockMessageDeliverer
extends Object
implements MessageDeliverer

A mock message deliverer that does nothing

Author:

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

Constructor Summary

Constructors

Constructor	Description
MockMessageDeliverer()

Method Summary

Modifier and Type	Method	Description
void	deliver(MessageDelivery messageDelivery)	This method is responsible for delivering the passed in messageDelivery record.
void	dismiss(MessageDelivery 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.
String	getDescription()	This method returns the human readable description for this plugin.
String	getName()	This method returns the human readable name of the plugin.
LinkedHashMap<String,String>	getPreferenceKeys()	This method is responsible for returning a list of preference key names along with their corresponding labels that get rendered in the UI.
String	getTitle()	This method returns the human readable Title of the plugin.
void	validatePreferenceValues(HashMap prefs)	This method is responsible for validating preference values when a person saves their preferences for the particular NotificationMessageDeliverer.

Methods inherited from class java.lang.Object

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

Constructor Details

MockMessageDeliverer

public MockMessageDeliverer()

Method Details

deliver

public void deliver(MessageDelivery messageDelivery)
             throws org.kuali.rice.kcb.api.exception.MessageDeliveryException

Description copied from interface: MessageDeliverer

This method is responsible for delivering the passed in messageDelivery record.

Specified by:

deliver in interface MessageDeliverer

Parameters:

messageDelivery - The messageDelivery to process

Throws:

org.kuali.rice.kcb.api.exception.MessageDeliveryException

See Also:

• MessageDeliverer.deliver(org.kuali.rice.kcb.bo.MessageDelivery)

dismiss

public void dismiss(MessageDelivery messageDelivery,
 String user,
 String cause)
             throws org.kuali.rice.kcb.api.exception.MessageDismissalException

Description copied from interface: MessageDeliverer

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:

dismiss in interface MessageDeliverer

Parameters:

messageDelivery - the messageDelivery to dismiss

user - the user that caused the dismissal; in the case of end-user actions, this will most likely be the user to which the message was delivered (user recipient in the NotificationMessageDelivery object)

cause - the reason the message was dismissed

Throws:

org.kuali.rice.kcb.api.exception.MessageDismissalException

See Also:

• MessageDeliverer.dismiss(org.kuali.rice.kcb.bo.MessageDelivery, java.lang.String, java.lang.String)

getDescription

public String getDescription()

Description copied from interface: MessageDeliverer

This method returns the human readable description for this plugin.

Specified by:

getDescription in interface MessageDeliverer

Returns:

String

See Also:

• MessageDeliverer.getDescription()

getName

public String getName()

Description copied from interface: MessageDeliverer

This method returns the human readable name of the plugin. This name is the key for this message delivery type. It must be unique and not contain any spaces.

Specified by:

getName in interface MessageDeliverer

Returns:

String

See Also:

• MessageDeliverer.getName()

getPreferenceKeys

public LinkedHashMap<String,String> getPreferenceKeys()

Description copied from interface: MessageDeliverer

This method is responsible for returning a list of preference key names along with their corresponding labels that get rendered in the UI. For example, if you were creating a NotificationEmailDeliverer class, one of the key preferences that this method would return back would be "email_address" and the label would be "Email Address".

Specified by:

getPreferenceKeys in interface MessageDeliverer

Returns:

LinkedHashMap

See Also:

• MessageDeliverer.getPreferenceKeys()

getTitle

public String getTitle()

Description copied from interface: MessageDeliverer

This method returns the human readable Title of the plugin. This name is the string used for identifying the plugin in the UI. It may contain spaces characters.

Specified by:

getTitle in interface MessageDeliverer

Returns:

String

See Also:

• MessageDeliverer.getTitle()

validatePreferenceValues

public void validatePreferenceValues(HashMap prefs)
                              throws ErrorList

Description copied from interface: MessageDeliverer

This method is responsible for validating preference values when a person saves their preferences for the particular NotificationMessageDeliverer. For example, if "phoneNumber" is one of the preferences for an SMS deliverer, then this method would be responsible for validating the value entered by a particular user such that it was properly constructed with hyphens or not, etc. Errors would be constructed and added to the ErrorList instance and be thrown from the method if any occurred.

Specified by:

validatePreferenceValues in interface MessageDeliverer

Throws:

ErrorList

See Also:

• MessageDeliverer.validatePreferenceValues(java.util.HashMap)