org.kuali.rice.krad.impls
Class MockWorkflowDocument

java.lang.Object
  org.kuali.rice.krad.impls.MockWorkflowDocument

All Implemented Interfaces:

DocumentContract, WorkflowDocument

public abstract class MockWorkflowDocument
extends Object
implements WorkflowDocument

This class is the base class for a MockWorkflowDocument. It can be extended by any other kind of mock document that needs to override certain methods. This class has absolutely no state or behavior. There is no public constructor, and no member variables. All void methods do nothing. All methods with a return value return null. All state and behavior needs to be added via a subclass.

Author:

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

Constructor Summary

MockWorkflowDocument()

Method Summary

void	acknowledge(String annotation)
void	addAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)
void	addSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)
void	adHocToGroup(ActionRequestType actionRequested, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction)
void	adHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction)
void	adHocToGroup(ActionRequestType actionRequested, String nodeName, String annotation, String targetGroupId, String responsibilityDescription, boolean forceAction, String requestLabel)
void	adHocToPrincipal(ActionRequestType actionRequested, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction)
void	adHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction)
void	adHocToPrincipal(ActionRequestType actionRequested, String nodeName, String annotation, String targetPrincipalId, String responsibilityDescription, boolean forceAction, String requestLabel)
void	approve(String annotation)
void	blanketApprove(String annotation)
void	blanketApprove(String annotation, String... nodeNames)
void	cancel(String annotation)
boolean	checkStatus(DocumentStatus status)
void	clearAttributeContent()
void	clearAttributeDefinitions()
void	clearSearchableContent()
void	clearSearchableDefinitions()
void	complete(String annotation)
void	delete()
void	disapprove(String annotation)
void	fyi()
void	fyi(String annotation)
List<ActionTaken>	getActionsTaken()
List<RouteNodeInstance>	getActiveRouteNodeInstances()
String	getApplicationContent()
String	getApplicationDocumentId()
String	getApplicationDocumentStatus()
org.joda.time.DateTime	getApplicationDocumentStatusDate()
String	getAttributeContent()
List<WorkflowAttributeDefinition>	getAttributeDefinitions()
String	getClearFutureRequestsValue()
org.joda.time.DateTime	getDateApproved()
org.joda.time.DateTime	getDateCreated()
org.joda.time.DateTime	getDateFinalized()
org.joda.time.DateTime	getDateLastModified()
Document	getDocument()
DocumentContent	getDocumentContent()
DocumentDetail	getDocumentDetail()
String	getDocumentHandlerUrl()
String	getDocumentId()
String	getDocumentTypeId()
String	getDocumentTypeName()
String	getDoNotReceiveFutureRequestsValue()
String	getInitiatorPrincipalId()
Set<String>	getNodeNames()
List<String>	getPreviousNodeNames()
String	getPrincipalId()
String	getReceiveFutureRequestsValue()
RequestedActions	getRequestedActions()
List<ActionRequest>	getRootActionRequests()
String	getRoutedByPrincipalId()
List<RouteNodeInstance>	getRouteNodeInstances()
List<WorkflowAttributeDefinition>	getSearchableDefinitions()
DocumentStatus	getStatus()
String	getTitle()
ValidActions	getValidActions()
Map<String,String>	getVariables()
String	getVariableValue(String name)
boolean	isAcknowledgeRequested()
boolean	isApprovalRequested()
boolean	isApproved()
boolean	isBlanketApproveCapable()
boolean	isCanceled()
boolean	isCompletionRequested()
boolean	isDisapproved()
boolean	isEnroute()
boolean	isException()
boolean	isFinal()
boolean	isFYIRequested()
boolean	isInitiated()
boolean	isProcessed()
boolean	isRouteCapable()
boolean	isSaved()
boolean	isValidAction(ActionType actionType)
void	logAnnotation(String annotation)
void	move(MovePoint movePoint, String annotation)
void	placeInExceptionRouting(String annotation)
void	refresh()
void	releaseGroupAuthority(String annotation, String groupId)
void	removeAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)
void	removeSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)
void	returnToPreviousNode(ReturnPoint returnPoint, String annotation)
void	returnToPreviousNode(String nodeName, String annotation)
void	revokeAdHocRequestById(String actionRequestId, String annotation)
void	revokeAdHocRequests(AdHocRevoke revoke, String annotation)
void	revokeAllAdHocRequests(String annotation)
void	route(String annotation)
void	saveDocument(String annotation)
void	saveDocumentData()
void	setApplicationContent(String applicationContent)
void	setApplicationDocumentId(String applicationDocumentId)
void	setApplicationDocumentStatus(String applicationDocumentStatus)
void	setClearFutureRequests()
void	setDoNotReceiveFutureRequests()
void	setReceiveFutureRequests()
void	setTitle(String title)
void	setVariable(String name, String value)
void	superUserBlanketApprove(String annotation)
void	superUserCancel(String annotation)
void	superUserDisapprove(String annotation)
void	superUserNodeApprove(String nodeName, String annotation)
void	superUserReturnToPreviousNode(ReturnPoint returnPoint, String annotation)
void	superUserTakeRequestedAction(String actionRequestId, String annotation)
void	switchPrincipal(String principalId)
void	takeGroupAuthority(String annotation, String groupId)
void	updateDocumentContent(DocumentContentUpdate documentContentUpdate)
List<? extends RemotableAttributeErrorContract>	validateAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.kew.api.WorkflowDocument

adHocToGroup, adHocToPrincipal, getCurrentNodeNames, getCurrentRouteNodeInstances, setAttributeContent, setSearchableContent

Constructor Detail

MockWorkflowDocument

public MockWorkflowDocument()

Method Detail

getDateLastModified

public org.joda.time.DateTime getDateLastModified()

Specified by:

getDateLastModified in interface DocumentContract

getDateApproved

public org.joda.time.DateTime getDateApproved()

Specified by:

getDateApproved in interface DocumentContract

getDateFinalized

public org.joda.time.DateTime getDateFinalized()

Specified by:

getDateFinalized in interface DocumentContract

getInitiatorPrincipalId

public String getInitiatorPrincipalId()

Specified by:

getInitiatorPrincipalId in interface DocumentContract

getRoutedByPrincipalId

public String getRoutedByPrincipalId()

Specified by:

getRoutedByPrincipalId in interface DocumentContract

getDocumentTypeId

public String getDocumentTypeId()

Specified by:

getDocumentTypeId in interface DocumentContract

getDocumentHandlerUrl

public String getDocumentHandlerUrl()

Specified by:

getDocumentHandlerUrl in interface DocumentContract

getApplicationDocumentStatus

public String getApplicationDocumentStatus()

Specified by:

getApplicationDocumentStatus in interface DocumentContract

getApplicationDocumentStatusDate

public org.joda.time.DateTime getApplicationDocumentStatusDate()

Specified by:

getApplicationDocumentStatusDate in interface DocumentContract

getVariables

public Map<String,String> getVariables()

Specified by:

getVariables in interface DocumentContract

getDocumentId

public String getDocumentId()

Specified by:

getDocumentId in interface DocumentContract

getDocument

public Document getDocument()

Specified by:

getDocument in interface WorkflowDocument

getDocumentContent

public DocumentContent getDocumentContent()

Specified by:

getDocumentContent in interface WorkflowDocument

getApplicationContent

public String getApplicationContent()

Specified by:

getApplicationContent in interface WorkflowDocument

setApplicationContent

public void setApplicationContent(String applicationContent)

Specified by:

setApplicationContent in interface WorkflowDocument

clearAttributeContent

public void clearAttributeContent()

Specified by:

clearAttributeContent in interface WorkflowDocument

getAttributeContent

public String getAttributeContent()

Specified by:

getAttributeContent in interface WorkflowDocument

addAttributeDefinition

public void addAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

Specified by:

addAttributeDefinition in interface WorkflowDocument

removeAttributeDefinition

public void removeAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

Specified by:

removeAttributeDefinition in interface WorkflowDocument

clearAttributeDefinitions

public void clearAttributeDefinitions()

Specified by:

clearAttributeDefinitions in interface WorkflowDocument

getAttributeDefinitions

public List<WorkflowAttributeDefinition> getAttributeDefinitions()

Specified by:

getAttributeDefinitions in interface WorkflowDocument

addSearchableDefinition

public void addSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)

Specified by:

addSearchableDefinition in interface WorkflowDocument

removeSearchableDefinition

public void removeSearchableDefinition(WorkflowAttributeDefinition searchableDefinition)

Specified by:

removeSearchableDefinition in interface WorkflowDocument

clearSearchableDefinitions

public void clearSearchableDefinitions()

Specified by:

clearSearchableDefinitions in interface WorkflowDocument

clearSearchableContent

public void clearSearchableContent()

Specified by:

clearSearchableContent in interface WorkflowDocument

getSearchableDefinitions

public List<WorkflowAttributeDefinition> getSearchableDefinitions()

Specified by:

getSearchableDefinitions in interface WorkflowDocument

validateAttributeDefinition

public List<? extends RemotableAttributeErrorContract> validateAttributeDefinition(WorkflowAttributeDefinition attributeDefinition)

Specified by:

validateAttributeDefinition in interface WorkflowDocument

getRootActionRequests

public List<ActionRequest> getRootActionRequests()

Specified by:

getRootActionRequests in interface WorkflowDocument

getActionsTaken

public List<ActionTaken> getActionsTaken()

Specified by:

getActionsTaken in interface WorkflowDocument

setApplicationDocumentId

public void setApplicationDocumentId(String applicationDocumentId)

Specified by:

setApplicationDocumentId in interface WorkflowDocument

getApplicationDocumentId

public String getApplicationDocumentId()

Specified by:

getApplicationDocumentId in interface DocumentContract

getDateCreated

public org.joda.time.DateTime getDateCreated()

Specified by:

getDateCreated in interface DocumentContract

getTitle

public String getTitle()

Specified by:

getTitle in interface DocumentContract

getValidActions

public ValidActions getValidActions()

Specified by:

getValidActions in interface WorkflowDocument

getRequestedActions

public RequestedActions getRequestedActions()

Specified by:

getRequestedActions in interface WorkflowDocument

saveDocument

public void saveDocument(String annotation)

Specified by:

saveDocument in interface WorkflowDocument

route

public void route(String annotation)

Specified by:

route in interface WorkflowDocument

disapprove

public void disapprove(String annotation)

Specified by:

disapprove in interface WorkflowDocument

approve

public void approve(String annotation)

Specified by:

approve in interface WorkflowDocument

cancel

public void cancel(String annotation)

Specified by:

cancel in interface WorkflowDocument

blanketApprove

public void blanketApprove(String annotation)

Specified by:

blanketApprove in interface WorkflowDocument

blanketApprove

public void blanketApprove(String annotation,
                           String... nodeNames)

Specified by:

blanketApprove in interface WorkflowDocument

saveDocumentData

public void saveDocumentData()

Specified by:

saveDocumentData in interface WorkflowDocument

setApplicationDocumentStatus

public void setApplicationDocumentStatus(String applicationDocumentStatus)

Specified by:

setApplicationDocumentStatus in interface WorkflowDocument

acknowledge

public void acknowledge(String annotation)

Specified by:

acknowledge in interface WorkflowDocument

fyi

public void fyi(String annotation)

Specified by:

fyi in interface WorkflowDocument

fyi

public void fyi()

Specified by:

fyi in interface WorkflowDocument

delete

public void delete()

Specified by:

delete in interface WorkflowDocument

refresh

public void refresh()

Specified by:

refresh in interface WorkflowDocument

adHocToPrincipal

public void adHocToPrincipal(ActionRequestType actionRequested,
                             String annotation,
                             String targetPrincipalId,
                             String responsibilityDescription,
                             boolean forceAction)

Specified by:

adHocToPrincipal in interface WorkflowDocument

adHocToPrincipal

public void adHocToPrincipal(ActionRequestType actionRequested,
                             String nodeName,
                             String annotation,
                             String targetPrincipalId,
                             String responsibilityDescription,
                             boolean forceAction)

Specified by:

adHocToPrincipal in interface WorkflowDocument

adHocToPrincipal

public void adHocToPrincipal(ActionRequestType actionRequested,
                             String nodeName,
                             String annotation,
                             String targetPrincipalId,
                             String responsibilityDescription,
                             boolean forceAction,
                             String requestLabel)

Specified by:

adHocToPrincipal in interface WorkflowDocument

adHocToGroup

public void adHocToGroup(ActionRequestType actionRequested,
                         String annotation,
                         String targetGroupId,
                         String responsibilityDescription,
                         boolean forceAction)

Specified by:

adHocToGroup in interface WorkflowDocument

adHocToGroup

public void adHocToGroup(ActionRequestType actionRequested,
                         String nodeName,
                         String annotation,
                         String targetGroupId,
                         String responsibilityDescription,
                         boolean forceAction)

Specified by:

adHocToGroup in interface WorkflowDocument

adHocToGroup

public void adHocToGroup(ActionRequestType actionRequested,
                         String nodeName,
                         String annotation,
                         String targetGroupId,
                         String responsibilityDescription,
                         boolean forceAction,
                         String requestLabel)

Specified by:

adHocToGroup in interface WorkflowDocument

revokeAdHocRequestById

public void revokeAdHocRequestById(String actionRequestId,
                                   String annotation)

Specified by:

revokeAdHocRequestById in interface WorkflowDocument

revokeAdHocRequests

public void revokeAdHocRequests(AdHocRevoke revoke,
                                String annotation)

Specified by:

revokeAdHocRequests in interface WorkflowDocument

revokeAllAdHocRequests

public void revokeAllAdHocRequests(String annotation)

Specified by:

revokeAllAdHocRequests in interface WorkflowDocument

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface WorkflowDocument

getDocumentTypeName

public String getDocumentTypeName()

Specified by:

getDocumentTypeName in interface DocumentContract

isCompletionRequested

public boolean isCompletionRequested()

Specified by:

isCompletionRequested in interface WorkflowDocument

isApprovalRequested

public boolean isApprovalRequested()

Specified by:

isApprovalRequested in interface WorkflowDocument

isAcknowledgeRequested

public boolean isAcknowledgeRequested()

Specified by:

isAcknowledgeRequested in interface WorkflowDocument

isFYIRequested

public boolean isFYIRequested()

Specified by:

isFYIRequested in interface WorkflowDocument

isBlanketApproveCapable

public boolean isBlanketApproveCapable()

Specified by:

isBlanketApproveCapable in interface WorkflowDocument

isRouteCapable

public boolean isRouteCapable()

Specified by:

isRouteCapable in interface WorkflowDocument

isValidAction

public boolean isValidAction(ActionType actionType)

Specified by:

isValidAction in interface WorkflowDocument

superUserBlanketApprove

public void superUserBlanketApprove(String annotation)

Specified by:

superUserBlanketApprove in interface WorkflowDocument

superUserNodeApprove

public void superUserNodeApprove(String nodeName,
                                 String annotation)

Specified by:

superUserNodeApprove in interface WorkflowDocument

superUserTakeRequestedAction

public void superUserTakeRequestedAction(String actionRequestId,
                                         String annotation)

Specified by:

superUserTakeRequestedAction in interface WorkflowDocument

superUserDisapprove

public void superUserDisapprove(String annotation)

Specified by:

superUserDisapprove in interface WorkflowDocument

superUserCancel

public void superUserCancel(String annotation)

Specified by:

superUserCancel in interface WorkflowDocument

superUserReturnToPreviousNode

public void superUserReturnToPreviousNode(ReturnPoint returnPoint,
                                          String annotation)

Specified by:

superUserReturnToPreviousNode in interface WorkflowDocument

complete

public void complete(String annotation)

Specified by:

complete in interface WorkflowDocument

logAnnotation

public void logAnnotation(String annotation)

Specified by:

logAnnotation in interface WorkflowDocument

getStatus

public DocumentStatus getStatus()

Specified by:

getStatus in interface DocumentContract

checkStatus

public boolean checkStatus(DocumentStatus status)

Specified by:

checkStatus in interface WorkflowDocument

isInitiated

public boolean isInitiated()

Specified by:

isInitiated in interface WorkflowDocument

isSaved

public boolean isSaved()

Specified by:

isSaved in interface WorkflowDocument

isEnroute

public boolean isEnroute()

Specified by:

isEnroute in interface WorkflowDocument

isException

public boolean isException()

Specified by:

isException in interface WorkflowDocument

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface WorkflowDocument

isDisapproved

public boolean isDisapproved()

Specified by:

isDisapproved in interface WorkflowDocument

isApproved

public boolean isApproved()

Specified by:

isApproved in interface WorkflowDocument

isProcessed

public boolean isProcessed()

Specified by:

isProcessed in interface WorkflowDocument

isFinal

public boolean isFinal()

Specified by:

isFinal in interface WorkflowDocument

getPrincipalId

public String getPrincipalId()

Specified by:

getPrincipalId in interface WorkflowDocument

switchPrincipal

public void switchPrincipal(String principalId)

Specified by:

switchPrincipal in interface WorkflowDocument

takeGroupAuthority

public void takeGroupAuthority(String annotation,
                               String groupId)

Specified by:

takeGroupAuthority in interface WorkflowDocument

releaseGroupAuthority

public void releaseGroupAuthority(String annotation,
                                  String groupId)

Specified by:

releaseGroupAuthority in interface WorkflowDocument

getNodeNames

public Set<String> getNodeNames()

Specified by:

getNodeNames in interface WorkflowDocument

returnToPreviousNode

public void returnToPreviousNode(String nodeName,
                                 String annotation)

Specified by:

returnToPreviousNode in interface WorkflowDocument

returnToPreviousNode

public void returnToPreviousNode(ReturnPoint returnPoint,
                                 String annotation)

Specified by:

returnToPreviousNode in interface WorkflowDocument

move

public void move(MovePoint movePoint,
                 String annotation)

Specified by:

move in interface WorkflowDocument

getActiveRouteNodeInstances

public List<RouteNodeInstance> getActiveRouteNodeInstances()

Specified by:

getActiveRouteNodeInstances in interface WorkflowDocument

getRouteNodeInstances

public List<RouteNodeInstance> getRouteNodeInstances()

Specified by:

getRouteNodeInstances in interface WorkflowDocument

getPreviousNodeNames

public List<String> getPreviousNodeNames()

Specified by:

getPreviousNodeNames in interface WorkflowDocument

getDocumentDetail

public DocumentDetail getDocumentDetail()

Specified by:

getDocumentDetail in interface WorkflowDocument

updateDocumentContent

public void updateDocumentContent(DocumentContentUpdate documentContentUpdate)

Specified by:

updateDocumentContent in interface WorkflowDocument

placeInExceptionRouting

public void placeInExceptionRouting(String annotation)

Specified by:

placeInExceptionRouting in interface WorkflowDocument

setVariable

public void setVariable(String name,
                        String value)

Specified by:

setVariable in interface WorkflowDocument

getVariableValue

public String getVariableValue(String name)

Specified by:

getVariableValue in interface WorkflowDocument

setReceiveFutureRequests

public void setReceiveFutureRequests()

Specified by:

setReceiveFutureRequests in interface WorkflowDocument

setDoNotReceiveFutureRequests

public void setDoNotReceiveFutureRequests()

Specified by:

setDoNotReceiveFutureRequests in interface WorkflowDocument

setClearFutureRequests

public void setClearFutureRequests()

Specified by:

setClearFutureRequests in interface WorkflowDocument

getReceiveFutureRequestsValue

public String getReceiveFutureRequestsValue()

Specified by:

getReceiveFutureRequestsValue in interface WorkflowDocument

getDoNotReceiveFutureRequestsValue

public String getDoNotReceiveFutureRequestsValue()

Specified by:

getDoNotReceiveFutureRequestsValue in interface WorkflowDocument

getClearFutureRequestsValue

public String getClearFutureRequestsValue()

Specified by:

getClearFutureRequestsValue in interface WorkflowDocument