Package com.priint.pubserver.plannerapi.interfaces

Interface TasksServiceLocal

public interface TasksServiceLocal

Local interface for the Tasks service from the Planner API

Method Summary

Modifier and Type	Method	Description
java.lang.String	changeWorkflowStepForDocument(java.lang.String documentId, WorkflowStep workflowStep)	change workflow step for document
java.util.List<Document>	changeWorkflowStepForDocuments(java.lang.String workflowStepId, java.util.List<Document> documents)	change workflow step for documents
java.lang.String	changeWorkflowStepForPublication(java.lang.String publicationId, WorkflowStep workflowStep)	change workflow step for document
java.util.List<Publication>	changeWorkflowStepForPublications(java.lang.String workflowStepId, java.util.List<Publication> publications)	change workflow step for publications
Task	getTask(java.lang.String id)	Returns the task at the specified ID
java.util.List<Task>	getTasks(TasksFilter filter)	Returns tasks fulfilling the search criteria
Task	setTask(Task inputTask)	Modifies an existing task

Method Detail

getTask

Task getTask(java.lang.String id)
      throws PubServerException,
             java.lang.NumberFormatException

Returns the task at the specified ID

Parameters:

id - task ID

Returns:

the task

Throws:

PubServerException

java.lang.NumberFormatException

See Also:

Task

getTasks

java.util.List<Task> getTasks(TasksFilter filter)
                       throws PubServerException

Returns tasks fulfilling the search criteria

Parameters:

filter - search criteria in the TasksFilter object

Returns:

the list of tasks

Throws:

PubServerException

See Also:

Task, TasksFilter

setTask

Task setTask(Task inputTask)
      throws PubServerException

Modifies an existing task

posible to edit: emailtext, startdate, enddate, personID

Parameters:

inputTask - the task to change

Returns:

changed task

Throws:

PubServerException

See Also:

Task

changeWorkflowStepForDocument

java.lang.String changeWorkflowStepForDocument(java.lang.String documentId,
                                               WorkflowStep workflowStep)
                                        throws PubServerException

change workflow step for document

Parameters:

documentId - publication ID

workflowStep - next workflow step

Returns:

String if String is empty then the process of changing workflow step has been finished successful, otherwise we get error message

Throws:

PubServerException

See Also:

Task

changeWorkflowStepForPublication

java.lang.String changeWorkflowStepForPublication(java.lang.String publicationId,
                                                  WorkflowStep workflowStep)
                                           throws PubServerException

change workflow step for document

Parameters:

publicationId - publication ID

workflowStep - next workflow step

Returns:

String if String is empty then the process of changing workflow step has been finished successful, otherwise we get error message

Throws:

PubServerException

See Also:

Task

changeWorkflowStepForDocuments

java.util.List<Document> changeWorkflowStepForDocuments(java.lang.String workflowStepId,
                                                        java.util.List<Document> documents)
                                                 throws PubServerException

change workflow step for documents

Parameters:

workflowStepId - workflow step id which should be set

documents - the documents list of documents which should be changed

Returns:

List of documents

Throws:

PubServerException

See Also:

Task

changeWorkflowStepForPublications

java.util.List<Publication> changeWorkflowStepForPublications(java.lang.String workflowStepId,
                                                              java.util.List<Publication> publications)
                                                       throws PubServerException

change workflow step for publications

Parameters:

workflowStepId - workflow step id which should be set

publications - which will be changed

Returns:

List of publications

Throws:

PubServerException

See Also:

Task