org.kuali.rice.kew.api.action
Class ActionRequest.Builder

java.lang.Object
  extended by org.kuali.rice.kew.api.action.ActionRequest.Builder
All Implemented Interfaces:
Serializable, Identifiable, ModelBuilder, ActionRequestContract
Enclosing class:
ActionRequest

public static final class ActionRequest.Builder
extends Object
implements Serializable, ModelBuilder, ActionRequestContract

A builder which can be used to construct ActionRequest instances. Enforces the constraints of the ActionRequestContract.

See Also:
Serialized Form

Method Summary
 ActionRequest build()
          Returns an instance of the object being built by this builder based on the current state of the builder.
static ActionRequest.Builder create(ActionRequestContract contract)
           
static ActionRequest.Builder create(String id, ActionRequestType actionRequested, ActionRequestStatus status, String responsibilityId, String documentId, RecipientType recipientType)
           
 ActionRequestType getActionRequested()
           
 ActionTaken.Builder getActionTaken()
           
 String getAnnotation()
           
 List<ActionRequest.Builder> getChildRequests()
           
 org.joda.time.DateTime getDateCreated()
           
 DelegationType getDelegationType()
           
 String getDocumentId()
           
 String getGroupId()
           
 String getId()
          The unique identifier for an object.
 String getNodeName()
           
 String getParentActionRequestId()
           
 String getPrincipalId()
           
 int getPriority()
           
 String getQualifiedRoleName()
           
 String getQualifiedRoleNameLabel()
           
 RecipientType getRecipientType()
           
 String getRequestLabel()
           
 ActionRequestPolicy getRequestPolicy()
           
 String getResponsibilityDescription()
           
 String getResponsibilityId()
           
 String getRoleName()
           
 int getRouteLevel()
           
 String getRouteNodeInstanceId()
           
 ActionRequestStatus getStatus()
           
 boolean isCurrent()
           
 boolean isForceAction()
           
 void setActionRequested(ActionRequestType actionRequested)
           
 void setActionTaken(ActionTaken.Builder actionTaken)
           
 void setAnnotation(String annotation)
           
 void setChildRequests(List<ActionRequest.Builder> childRequests)
           
 void setCurrent(boolean current)
           
 void setDateCreated(org.joda.time.DateTime dateCreated)
           
 void setDelegationType(DelegationType delegationType)
           
 void setDocumentId(String documentId)
           
 void setForceAction(boolean forceAction)
           
 void setGroupId(String groupId)
           
 void setId(String id)
           
 void setNodeName(String nodeName)
           
 void setParentActionRequestId(String parentActionRequestId)
           
 void setPrincipalId(String principalId)
           
 void setPriority(int priority)
           
 void setQualifiedRoleName(String qualifiedRoleName)
           
 void setQualifiedRoleNameLabel(String qualifiedRoleNameLabel)
           
 void setRecipientType(RecipientType recipientType)
           
 void setRequestLabel(String requestLabel)
           
 void setRequestPolicy(ActionRequestPolicy requestPolicy)
           
 void setResponsibilityDescription(String responsibilityDescription)
           
 void setResponsibilityId(String responsibilityId)
           
 void setRoleName(String roleName)
           
 void setRouteLevel(int routeLevel)
           
 void setRouteNodeInstanceId(String routeNodeInstanceId)
           
 void setStatus(ActionRequestStatus status)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static ActionRequest.Builder create(String id,
                                           ActionRequestType actionRequested,
                                           ActionRequestStatus status,
                                           String responsibilityId,
                                           String documentId,
                                           RecipientType recipientType)

create

public static ActionRequest.Builder create(ActionRequestContract contract)

build

public ActionRequest build()
Description copied from interface: ModelBuilder
Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:
build in interface ModelBuilder
Returns:
an instance of the object being built by this builder, should never return null

getId

public String getId()
Description copied from interface: Identifiable
The unique identifier for an object. This can be null.

Specified by:
getId in interface Identifiable
Specified by:
getId in interface ActionRequestContract
Returns:
the id

getActionRequested

public ActionRequestType getActionRequested()
Specified by:
getActionRequested in interface ActionRequestContract

getStatus

public ActionRequestStatus getStatus()
Specified by:
getStatus in interface ActionRequestContract

isCurrent

public boolean isCurrent()
Specified by:
isCurrent in interface ActionRequestContract

getDateCreated

public org.joda.time.DateTime getDateCreated()
Specified by:
getDateCreated in interface ActionRequestContract

getResponsibilityId

public String getResponsibilityId()
Specified by:
getResponsibilityId in interface ActionRequestContract

getDocumentId

public String getDocumentId()
Specified by:
getDocumentId in interface ActionRequestContract

getPriority

public int getPriority()
Specified by:
getPriority in interface ActionRequestContract

getRouteLevel

public int getRouteLevel()
Specified by:
getRouteLevel in interface ActionRequestContract

getAnnotation

public String getAnnotation()
Specified by:
getAnnotation in interface ActionRequestContract

getRecipientType

public RecipientType getRecipientType()
Specified by:
getRecipientType in interface ActionRequestContract

getPrincipalId

public String getPrincipalId()
Specified by:
getPrincipalId in interface ActionRequestContract

getGroupId

public String getGroupId()
Specified by:
getGroupId in interface ActionRequestContract

getRequestPolicy

public ActionRequestPolicy getRequestPolicy()
Specified by:
getRequestPolicy in interface ActionRequestContract

getResponsibilityDescription

public String getResponsibilityDescription()
Specified by:
getResponsibilityDescription in interface ActionRequestContract

isForceAction

public boolean isForceAction()
Specified by:
isForceAction in interface ActionRequestContract

getDelegationType

public DelegationType getDelegationType()
Specified by:
getDelegationType in interface ActionRequestContract

getRoleName

public String getRoleName()
Specified by:
getRoleName in interface ActionRequestContract

getQualifiedRoleName

public String getQualifiedRoleName()
Specified by:
getQualifiedRoleName in interface ActionRequestContract

getQualifiedRoleNameLabel

public String getQualifiedRoleNameLabel()
Specified by:
getQualifiedRoleNameLabel in interface ActionRequestContract

getRouteNodeInstanceId

public String getRouteNodeInstanceId()
Specified by:
getRouteNodeInstanceId in interface ActionRequestContract

getNodeName

public String getNodeName()
Specified by:
getNodeName in interface ActionRequestContract

getRequestLabel

public String getRequestLabel()
Specified by:
getRequestLabel in interface ActionRequestContract

getParentActionRequestId

public String getParentActionRequestId()
Specified by:
getParentActionRequestId in interface ActionRequestContract

getActionTaken

public ActionTaken.Builder getActionTaken()
Specified by:
getActionTaken in interface ActionRequestContract

getChildRequests

public List<ActionRequest.Builder> getChildRequests()
Specified by:
getChildRequests in interface ActionRequestContract

setId

public void setId(String id)

setActionRequested

public void setActionRequested(ActionRequestType actionRequested)

setStatus

public void setStatus(ActionRequestStatus status)

setCurrent

public void setCurrent(boolean current)

setDateCreated

public void setDateCreated(org.joda.time.DateTime dateCreated)

setResponsibilityId

public void setResponsibilityId(String responsibilityId)

setDocumentId

public void setDocumentId(String documentId)

setPriority

public void setPriority(int priority)

setRouteLevel

public void setRouteLevel(int routeLevel)

setAnnotation

public void setAnnotation(String annotation)

setRecipientType

public void setRecipientType(RecipientType recipientType)

setPrincipalId

public void setPrincipalId(String principalId)

setGroupId

public void setGroupId(String groupId)

setRequestPolicy

public void setRequestPolicy(ActionRequestPolicy requestPolicy)

setResponsibilityDescription

public void setResponsibilityDescription(String responsibilityDescription)

setForceAction

public void setForceAction(boolean forceAction)

setDelegationType

public void setDelegationType(DelegationType delegationType)

setRoleName

public void setRoleName(String roleName)

setQualifiedRoleName

public void setQualifiedRoleName(String qualifiedRoleName)

setQualifiedRoleNameLabel

public void setQualifiedRoleNameLabel(String qualifiedRoleNameLabel)

setRouteNodeInstanceId

public void setRouteNodeInstanceId(String routeNodeInstanceId)

setNodeName

public void setNodeName(String nodeName)

setRequestLabel

public void setRequestLabel(String requestLabel)

setParentActionRequestId

public void setParentActionRequestId(String parentActionRequestId)

setActionTaken

public void setActionTaken(ActionTaken.Builder actionTaken)

setChildRequests

public void setChildRequests(List<ActionRequest.Builder> childRequests)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.