org.kuali.rice.kew.impl.document

Interface WorkflowDocumentPrototype

All Superinterfaces:

DocumentContract, WorkflowDocument

All Known Implementing Classes:

WorkflowDocumentImpl

public interface WorkflowDocumentPrototype
extends WorkflowDocument

An implementation/framework interface that extends WorkflowDocument with an initialization method used internally for construction.

Author:

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

Method Summary

Modifier and Type	Method and Description
void	init(String principalId, Document document) Initialize the WorkflowDocument

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

acknowledge, addAttributeDefinition, addSearchableDefinition, adHocToGroup, adHocToGroup, adHocToGroup, adHocToGroup, adHocToPrincipal, adHocToPrincipal, adHocToPrincipal, adHocToPrincipal, approve, blanketApprove, blanketApprove, cancel, checkStatus, clearAttributeContent, clearAttributeDefinitions, clearSearchableContent, clearSearchableDefinitions, complete, delete, disapprove, fyi, fyi, getActionsTaken, getActiveRouteNodeInstances, getApplicationContent, getAttributeContent, getAttributeDefinitions, getClearFutureRequestsValue, getCurrentNodeNames, getCurrentRouteNodeInstances, getDocument, getDocumentContent, getDocumentDetail, getDoNotReceiveFutureRequestsValue, getNodeNames, getPreviousNodeNames, getPrincipalId, getReceiveFutureRequestsValue, getRequestedActions, getRootActionRequests, getRouteNodeInstances, getSearchableDefinitions, getValidActions, getVariableValue, isAcknowledgeRequested, isApprovalRequested, isApproved, isBlanketApproveCapable, isCanceled, isCompletionRequested, isDisapproved, isEnroute, isException, isFinal, isFYIRequested, isInitiated, isProcessed, isRecalled, isRouteCapable, isSaved, isValidAction, logAnnotation, move, placeInExceptionRouting, recall, refresh, releaseGroupAuthority, removeAttributeDefinition, removeSearchableDefinition, returnToPreviousNode, returnToPreviousNode, revokeAdHocRequestById, revokeAdHocRequests, revokeAllAdHocRequests, route, saveDocument, saveDocumentData, setApplicationContent, setApplicationDocumentId, setApplicationDocumentStatus, setAttributeContent, setClearFutureRequests, setDoNotReceiveFutureRequests, setReceiveFutureRequests, setSearchableContent, setTitle, setVariable, superUserBlanketApprove, superUserCancel, superUserDisapprove, superUserNodeApprove, superUserReturnToPreviousNode, superUserTakeRequestedAction, switchPrincipal, takeGroupAuthority, updateDocumentContent, validateAttributeDefinition

Methods inherited from interface org.kuali.rice.kew.api.document.DocumentContract

getApplicationDocumentId, getApplicationDocumentStatus, getApplicationDocumentStatusDate, getDateApproved, getDateCreated, getDateFinalized, getDateLastModified, getDocumentHandlerUrl, getDocumentId, getDocumentTypeId, getDocumentTypeName, getInitiatorPrincipalId, getRoutedByPrincipalId, getStatus, getTitle, getVariables

Method Detail

init

void init(String principalId,
          Document document)

Initialize the WorkflowDocument

Parameters:

principalId - the interacting/consuming user principal id

document - the DTO of the document this WorkflowDocument represents