Package com.priint.pubserver.plannerapi.interfaces

Interface QueuesServiceLocal

public interface QueuesServiceLocal

Local interface for the Queues service from the Planner API

Method Summary

Modifier and Type	Method	Description
String	changeServerJobPriority(String id, int priority)	Change the server job priority in the queue
String	deleteFromQueue(String id, boolean throwTechnicalErrorForWorkflowJob)	Deletes the server job at the specified ID from the queue
Queue	getQueue(String id)	Returns queue at the specified ID
List<Queue>	getQueues(QueuesFilter filter)	Returns queues fulfilling the search criteria

Method Details

getQueue

Queue getQueue(String id)
        throws PubServerException

Returns queue at the specified ID

Parameters:

id - queue ID

Returns:

queue

Throws:

PubServerException

See Also:

• Queue

getQueues

List<Queue> getQueues(QueuesFilter filter)
               throws PubServerException

Returns queues fulfilling the search criteria

Parameters:

filter - search criteria in QueuesFilter object

Returns:

List of queues

Throws:

PubServerException

See Also:

• Queue

deleteFromQueue

String deleteFromQueue(String id,
 boolean throwTechnicalErrorForWorkflowJob)
                throws PubServerException

Deletes the server job at the specified ID from the queue

Parameters:

id - queue ID

throwTechnicalErrorForWorkflowJob - If true TechnicalErrorForWorkflowJob is thrown. In the majority of cases it should be set on true.

Returns:

queue ID

Throws:

PubServerException

changeServerJobPriority

String changeServerJobPriority(String id,
 int priority)
                        throws PubServerException

Change the server job priority in the queue

Parameters:

id - unique server name

priority -

Returns:

unique server name

Throws:

PubServerException