Package com.priint.pubserver.plannerapi.interfaces

Interface WorkflowsServiceLocal

public interface WorkflowsServiceLocal

Local interface for the Workflows service from the Planner API

Method Summary

Modifier and Type	Method	Description
List<Workflow>	addWorkflows(List<Workflow> workflows)	Creates the specified workflows
String	deleteWorkflow(String id)	Deletes the workflow at the specified ID
Workflow	getWorkflowById(String id)	Returns the workflow at the specified ID
List<Workflow>	getWorkflows(String type)	Returns workflows at the specified type
String	setWorkflow(Workflow workflow)	Modifies the specified workflow (by its inner ID)
Workflow	setWorkflowProcessForDocument(String documentId, Workflow workflow)	Set new workflow process for document.
List<Document>	setWorkflowProcessForDocuments(String workflowProcessId, List<Document> documents)	Set the workflow for the list of documents
Workflow	setWorkflowProcessForPublication(String publicationId, Workflow workflow)	Set new workflow process for publication.
List<Publication>	setWorkflowProcessForPublications(String workflowProcessId, List<Publication> publications)	Set the workflow for the list of publications
List<Workflow>	setWorkflows(List<Workflow> workflows)	Modifies the specified workflows

Method Details

getWorkflows

List<Workflow> getWorkflows(String type)
                     throws PubServerException

Returns workflows at the specified type

Parameters:

type - type of the workflow

Returns:

the list of workflows

Throws:

PubServerException

See Also:

• Workflow

getWorkflowById

Workflow getWorkflowById(String id)
                  throws PubServerException,
NumberFormatException

Returns the workflow at the specified ID

Parameters:

id - ID of the workflow

Returns:

the workflow

Throws:

PubServerException

NumberFormatException

See Also:

• Workflow

setWorkflow

String setWorkflow(Workflow workflow)
            throws PubServerException

Modifies the specified workflow (by its inner ID)

Parameters:

workflow - the workflow to modify

Returns:

modified workflow

Throws:

PubServerException

See Also:

• Workflow

setWorkflows

List<Workflow> setWorkflows(List<Workflow> workflows)
                     throws PubServerException

Modifies the specified workflows

Parameters:

workflows - the list of workflows to modify

Returns:

the list of processed workflow

Throws:

PubServerException

See Also:

• Workflow

addWorkflows

List<Workflow> addWorkflows(List<Workflow> workflows)
                     throws PubServerException

Creates the specified workflows

Parameters:

workflows - the list of workflows to create

Returns:

the list of processed workflow

Throws:

PubServerException

See Also:

• Workflow

deleteWorkflow

String deleteWorkflow(String id)
               throws PubServerException,
NumberFormatException

Deletes the workflow at the specified ID

Parameters:

id - workflow ID

Returns:

ID of workflow which was deleted

Throws:

PubServerException

NumberFormatException

See Also:

• Workflow

setWorkflowProcessForDocuments

List<Document> setWorkflowProcessForDocuments(String workflowProcessId,
 List<Document> documents)
                                       throws PubServerException

Set the workflow for the list of documents

Parameters:

workflowProcessId - workflow process ID

documents - the list of documents to set workflow process

Returns:

the list of documents which was setted

Throws:

PubServerException

See Also:

• Workflow

setWorkflowProcessForPublications

List<Publication> setWorkflowProcessForPublications(String workflowProcessId,
 List<Publication> publications)
                                             throws PubServerException

Set the workflow for the list of publications

Parameters:

workflowProcessId - workflow process ID

publications - the list of publications to set workflow process

Returns:

the list of publications which was setted

Throws:

PubServerException

See Also:

• Workflow

setWorkflowProcessForDocument

Workflow setWorkflowProcessForDocument(String documentId,
 Workflow workflow)
                                throws PubServerException

Set new workflow process for document.

Parameters:

documentId - documentId ID

workflow - workflow process

Returns:

workflow

Throws:

PubServerException

See Also:

• Task

setWorkflowProcessForPublication

Workflow setWorkflowProcessForPublication(String publicationId,
 Workflow workflow)
                                   throws PubServerException

Set new workflow process for publication.

Parameters:

publicationId - publication ID

workflow - workflow process

Returns:

workflow

Throws:

PubServerException

See Also:

• Task