Package org.kuali.rice.kew.api.document

Interface DocumentOrchestrationQueue

public interface DocumentOrchestrationQueue

Defines the contract for a message queue which handles orchestrating documents through the blanket approval process.

Author:

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

Method Summary

Modifier and Type	Method	Description
void	orchestrateDocument(String documentId, String principalId, OrchestrationConfig orchestrationConfig, DocumentProcessingOptions documentProcessingOptions)	Orchestrates the document with the given id through the blanket approval process to the specified list of node names.

Method Details

orchestrateDocument

void orchestrateDocument(String documentId,
 String principalId,
 OrchestrationConfig orchestrationConfig,
 DocumentProcessingOptions documentProcessingOptions)
                  throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException

Orchestrates the document with the given id through the blanket approval process to the specified list of node names. If the node names are empty, then the document will be orchestrated all the way to the end of its workflow process.

This orchestration can also optional index search attributes after orchestration has complete if the value for shouldSearchIndex is "true".

Parameters:

documentId - the id of the document to orchestrate through the blanket approval process

principalId - the id of the principal who initiated the blanket approval

orchestrationConfig - contains configuration for how the orchestration should be performed

Throws:

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if documentId is a null or blank value

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if principalId is a null or blank value

org.kuali.rice.core.api.exception.RiceIllegalArgumentException - if orchestrationConfig is null