org.kuali.rice.kew.api.action

Class RequestedActions

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kew.api.action.RequestedActions

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete

public final class RequestedActions
extends AbstractDataTransferObject

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	contains(ActionRequestType actionRequestType) Returns true if this set of requested actions contains the given action request type.
static RequestedActions	create(boolean completeRequested, boolean approveRequested, boolean acknowledgeRequested, boolean fyiRequested)
Set<ActionRequestType>	getRequestedActions() Returns a Set of ActionRequestTypes which indicate the actions which have been requested.
boolean	isAcknowledgeRequested()
boolean	isApproveRequested()
boolean	isCompleteRequested()
boolean	isFyiRequested()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static RequestedActions create(boolean completeRequested,
                                      boolean approveRequested,
                                      boolean acknowledgeRequested,
                                      boolean fyiRequested)

isCompleteRequested

public boolean isCompleteRequested()

isApproveRequested

public boolean isApproveRequested()

isAcknowledgeRequested

public boolean isAcknowledgeRequested()

isFyiRequested

public boolean isFyiRequested()

getRequestedActions

public Set<ActionRequestType> getRequestedActions()

Returns a Set of ActionRequestTypes which indicate the actions which have been requested. This will essentially contain request types for any of the request-related methods on this class which return "true". If no actions are requested, the empty set will be returned (this method will never return null).

Returns:

an unmodifiable Set of action request types which have been requested, or an empty set if no actions are requested

contains

public boolean contains(ActionRequestType actionRequestType)

Returns true if this set of requested actions contains the given action request type.

Parameters:

actionRequestType - the ActionRequestType to check for, can't be null

Returns:

true if the action is requested, false otherwise

Throws:

IllegalArgumentException - if actionRequestType is null