org.kuali.kra.kew

Interface KraDocumentRejectionService

All Known Implementing Classes:

KraDocumentRejectionServiceImpl

public interface KraDocumentRejectionService

Encapsulates reject functionality. Reject == return the document to the intial workflow node and generate an approval action for the initiator.

Method Summary

Methods

Modifier and Type	Method and Description
String	getWorkflowInitialNodeName(String documentType) Get the name of the first workflow node for the document.
boolean	isDocumentOnInitialNode(org.kuali.rice.krad.document.Document documentNumber) Determine if the document is on it's initial node.
boolean	isDocumentOnInitialNode(String documentNumber) Determine if the document is on it's initial node.
boolean	isDocumentOnNode(org.kuali.rice.krad.document.Document documentNumber, String nodeName) Determine if the document is on a particular node.
boolean	isDocumentOnNode(String documentNumber, String nodeName) Determine if the document is on a particular node.
void	reject(org.kuali.rice.krad.document.Document document, String reason, String principalId) Reject a document.
void	reject(org.kuali.rice.krad.document.Document document, String reason, String principalId, String appDocStatus) Reject a document.
void	reject(org.kuali.rice.krad.document.Document document, String reason, String principalId, String appDocStatus, String nodeName) Reject a document and send it back to a particular node.
void	reject(String documentNumber, String reason, String principalId) Reject a document.
void	reject(String documentNumber, String reason, String principalId, String appDocStatus) Reject a document.

Method Detail

reject

void reject(org.kuali.rice.krad.document.Document document,
          String reason,
          String principalId,
          String appDocStatus)

Reject a document.

Parameters:

documentNumber - The number of the document to reject.

reason - An explanation of why the document has been rejected.

principalId - The principal to reject the document as.

appDocStatus - The application document status for the document. Only applied if non-null.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

reject

void reject(org.kuali.rice.krad.document.Document document,
          String reason,
          String principalId)

Reject a document.

Parameters:

documentNumber - The number of the document to reject.

reason - An explanation of why the document has been rejected.

principalId - The principal to reject the document as.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

reject

void reject(String documentNumber,
          String reason,
          String principalId,
          String appDocStatus)

Reject a document.

Parameters:

documentNumber - The number of the document to reject.

reason - An explanation of why the document has been rejected.

principalId - The principal to reject the document as.

appDocStatus - The application document status for the document. Only applied if non-null.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

reject

void reject(String documentNumber,
          String reason,
          String principalId)

Reject a document.

Parameters:

documentNumber - The number of the document to reject.

reason - An explanation of why the document has been rejected.

principalId - The principal to reject the document as.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getWorkflowInitialNodeName

String getWorkflowInitialNodeName(String documentType)

Get the name of the first workflow node for the document.

Parameters:

documentType - The document type you want the initial node for.

Returns:

The name of the initial workflow node.

isDocumentOnInitialNode

boolean isDocumentOnInitialNode(String documentNumber)

Determine if the document is on it's initial node. A document can be in workflow and on it's initial node if it has been rejected ( returned to the initial node ).

Parameters:

documentNumber -

Returns:

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

isDocumentOnInitialNode

boolean isDocumentOnInitialNode(org.kuali.rice.krad.document.Document documentNumber)

Determine if the document is on it's initial node. A document can be in workflow and on it's initial node if it has been rejected ( returned to the initial node ).

Parameters:

documentNumber -

Returns:

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

isDocumentOnNode

boolean isDocumentOnNode(String documentNumber,
                       String nodeName)

Determine if the document is on a particular node.

Parameters:

documentNumber -

nodeName -

Returns:

isDocumentOnNode

boolean isDocumentOnNode(org.kuali.rice.krad.document.Document documentNumber,
                       String nodeName)

Determine if the document is on a particular node.

Parameters:

documentNumber -

nodeName -

Returns:

reject

void reject(org.kuali.rice.krad.document.Document document,
          String reason,
          String principalId,
          String appDocStatus,
          String nodeName)

Reject a document and send it back to a particular node.

Parameters:

document - The document number to reject

reason - An explanation of why the document has been rejected.

principalId - The principal to reject the document as.

appDocStatus - The application document status for the document. Only applied if non-null.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException