|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JobExecutionService
Service that provides methods for executing jobs in the repository and in the user's workspace and for getting the status of the submitted job.
Method Summary | |
---|---|
JobStatus |
getJobSubmissionStatus(JobSubmission jobSubmission)
Gets the current job submission status for a specific submission of a job. |
JobSubmission |
submitJobInRepository(String jobPath,
String version,
Set<ParameterValue> params)
Submits job in the repository. |
JobSubmission |
submitJobInWorkspace(String jobPath,
Set<ParameterValue> params)
Submits job in the current user's workspace. |
Method Detail |
---|
JobSubmission submitJobInWorkspace(String jobPath, Set<ParameterValue> params) throws JobExecutionException, JobNotFoundException
jobPath
- Path of job to submitparams
- ParameterValues will override the default value of the JobParameters defined within the job. For
parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values
of CHARACTER and NUMERIC parameters should be specified as Strings. Values of DATE parameter type
should be specified as java.util.Date. If no parameters are specified, the default values defined in
the job will be used.
JobExecutionException
- Thrown if an issue occurred executing the job
JobNotFoundException
- Thrown if the job does not exist at the path specified in the workspaceJobSubmission submitJobInRepository(String jobPath, String version, Set<ParameterValue> params) throws JobExecutionException, JobNotFoundException, JobVersionNotFoundException
jobPath
- Path of job to submitversion
- Version of repository job to run. Specifying null will run the latest version of the job.params
- ParameterValues will override the default value of the JobParameters defined within the job. For
parameters of type FILE and FOLDER, the value should be specified as a ResourceSpecification. Values
of CHARACTER and NUMERIC parameters should be specified as Strings. Date parameter values should be
specified as java.util.Date. If no parameters are specified, the default values in the job will be
used.
JobExecutionException
- Thrown if an issue occurred executing the job
JobNotFoundException
- Thrown if the job does not exist at the path specified in the repository
JobVersionNotFoundException
- Thrown if the version of the job does not exist in the repositoryJobStatus getJobSubmissionStatus(JobSubmission jobSubmission)
JobStatus
for status details.
jobSubmission
- JobSubmission returned from submitting a job.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |