Package com.priint.pubserver.plannerapi.interfaces

Interface ServerJobsServiceLocal

public interface ServerJobsServiceLocal

Local interface for the ServerJobs service from the Planner API

Method Summary

Modifier and Type	Method	Description
java.lang.String	deleteScheduleServerJob(java.lang.String id, boolean throwTechnicalErrorForWorkflowJob)	Deletes scheduled server job at the specified ID
ServerJob	getServerJob(java.lang.String id)	Returns the server job at the specified ID
java.util.List<ServerJob>	getServerJobs(ServerJobsFilter filter)	Returns server jobs fulfilling the search criteria
java.util.List<ServerJob>	getServerJobsForDocumentID(java.lang.String documentID, ServerJobsFilter filter)	Returns server jobs for the specified document and fulfilling search criteria
java.util.List<ServerJob>	getServerJobsForPublicationID(java.lang.String publicationID, ServerJobsFilter filter)	Returns server jobs for the specified publication and fulfilling search criteria
ServerJob	setServerJobScheduleTime(ServerJob job)	Changes schedule time of server job.
java.util.List<ServerJob>	setServerJobScheduleTime(java.util.List<ServerJob> jobs)	Changes schedule time for server jobs.
java.util.List<ServerJob>	setServerJobsForPublicationID(java.lang.String publicationID, java.util.List<ServerJob> serverJobs)	Sets server jobs for the specified publications

Method Detail

getServerJob

ServerJob getServerJob(java.lang.String id)
                throws PubServerException

Returns the server job at the specified ID

Parameters:

id - server job ID

Returns:

server job

Throws:

PubServerException

See Also:

ServerJob

getServerJobs

java.util.List<ServerJob> getServerJobs(ServerJobsFilter filter)
                                 throws PubServerException

Returns server jobs fulfilling the search criteria

Parameters:

filter - search criteria in ServerJobsFilter object

Returns:

List of server jobs

Throws:

PubServerException

See Also:

ServerJob, ServerJobsFilter

setServerJobScheduleTime

ServerJob setServerJobScheduleTime(ServerJob job)
                            throws PubServerException

Changes schedule time of server job.

Parameters:

job - server job

Returns:

changed server job

Throws:

PubServerException

See Also:

ServerJob

setServerJobScheduleTime

java.util.List<ServerJob> setServerJobScheduleTime(java.util.List<ServerJob> jobs)
                                            throws PubServerException

Changes schedule time for server jobs.

Parameters:

jobs - the list of server jobs to change schedule time

Returns:

the list of changed server jobs

Throws:

PubServerException

See Also:

ServerJob

deleteScheduleServerJob

java.lang.String deleteScheduleServerJob(java.lang.String id,
                                         boolean throwTechnicalErrorForWorkflowJob)
                                  throws PubServerException

Deletes scheduled server job at the specified ID

Parameters:

id - server job ID

throwTechnicalErrorForWorkflowJob - If true an exception is thrown. In most cases is set to true

Returns:

ID of deleted server job

Throws:

PubServerException

getServerJobsForDocumentID

java.util.List<ServerJob> getServerJobsForDocumentID(java.lang.String documentID,
                                                     ServerJobsFilter filter)
                                              throws PubServerException

Returns server jobs for the specified document and fulfilling search criteria

Parameters:

documentID - document ID

filter - search criteria in ServerJobsFilter object

Returns:

the list of server jobs

Throws:

PubServerException

See Also:

ServerJob, ServerJobsFilter

getServerJobsForPublicationID

java.util.List<ServerJob> getServerJobsForPublicationID(java.lang.String publicationID,
                                                        ServerJobsFilter filter)
                                                 throws PubServerException

Returns server jobs for the specified publication and fulfilling search criteria

Parameters:

publicationID - publication ID

filter - search criteria in ServerJobsFilter object

Returns:

the list of server jobs

Throws:

PubServerException

See Also:

ServerJob, ServerJobsFilter

setServerJobsForPublicationID

java.util.List<ServerJob> setServerJobsForPublicationID(java.lang.String publicationID,
                                                        java.util.List<ServerJob> serverJobs)
                                                 throws PubServerException

Sets server jobs for the specified publications

Parameters:

publicationID - publication ID

serverJobs - the list of server jobs to set

Returns:

the list of processed server jobs

Throws:

PubServerException