public class JobServiceImpl extends Object implements JobService
| Constructor and Description |
|---|
JobServiceImpl() |
| Modifier and Type | Method and Description |
|---|---|
@NotNull ImmutableJob |
addJob(@NotNull PlanKey chainKey,
long stageId,
@Nullable String jobKeyString,
@Nullable String name,
@Nullable String description,
boolean suspended)
Add a job to an existing stage in the plan
|
ImmutableJob |
cloneJob(@NotNull String sourceJobKeyString,
@NotNull PlanKey chainKey,
long stageId,
@NotNull String newJobKeyString,
@NotNull String name,
@Nullable String description,
boolean suspended)
Copy the given job and give the copy the key, name, description and suspended state provided.
|
void |
deleteJob(@NotNull PlanKey jobKey,
BambooClosures.Throwing1<ImmutableJob,WebValidationException>... runBefore)
Remove a job.
|
@NotNull ImmutableJob |
getJob(@NotNull PlanKey jobKey)
Get an individual job
|
@NotNull List<ImmutableJob> |
getJobsForPlan(@NotNull PlanKey planKey)
Assumption is made that
AbstractImmutableChain.getAllJobs() will return 2-level sorted list of jobs |
@NotNull List<ImmutableJob> |
getJobsForStage(@NotNull PlanKey planKey,
long stageId)
Get all jobs in a particular stage, ordered alphabetically
|
@NotNull ImmutableJob |
updateJob(@NotNull PlanKey jobKey,
@NotNull String name,
@Nullable String description,
boolean suspended,
long stageId,
BambooClosures.Throwing1<ImmutableJob,WebValidationException>... runBefore)
Update the details of a job
|
ErrorCollection |
validateJobForAdd(@NotNull PlanKey planKey,
long stageId,
@Nullable String jobKey,
@Nullable String name,
@Nullable String description,
boolean suspended)
Validates the parameters for adding a job.
|
ErrorCollection |
validateJobForClone(@Nullable String sourceJobKeyString,
@NotNull PlanKey chainKey,
long stageId,
@Nullable String newJobKey,
@Nullable String name,
@Nullable String description,
@Nullable Boolean suspended)
Validates the parameters for cloning a job.
|
@NotNull ErrorCollection |
validateJobForUpdate(@NotNull PlanKey jobKey,
@NotNull String name,
@Nullable String description,
boolean suspended,
long stageId)
Validate editing of a job
|
@NotNull public @NotNull List<ImmutableJob> getJobsForPlan(@NotNull @NotNull PlanKey planKey)
AbstractImmutableChain.getAllJobs() will return 2-level sorted list of jobsgetJobsForPlan in interface JobServiceplanKey - of plan@NotNull public @NotNull List<ImmutableJob> getJobsForStage(@NotNull @NotNull PlanKey planKey, long stageId)
JobServicegetJobsForStage in interface JobServiceplanKey - of planstageId - id of the stage@NotNull public @NotNull ImmutableJob getJob(@NotNull @NotNull PlanKey jobKey)
JobServicegetJob in interface JobServicejobKey - of the job to getpublic ErrorCollection validateJobForAdd(@NotNull @NotNull PlanKey planKey, long stageId, @Nullable @Nullable String jobKey, @Nullable @Nullable String name, @Nullable @Nullable String description, boolean suspended) throws WebValidationException
JobServicevalidateJobForAdd in interface JobServiceplanKey - of the plan to add job to.stageId - of the stage to add the job to.jobKey - key of the job to add. May be full or partial job key.name - name of the job to add.description - description of the job.suspended - sets the job's suspended status.WebValidationException@NotNull public @NotNull ImmutableJob addJob(@NotNull @NotNull PlanKey chainKey, long stageId, @Nullable @Nullable String jobKeyString, @Nullable @Nullable String name, @Nullable @Nullable String description, boolean suspended) throws WebValidationException
JobServiceaddJob in interface JobServicechainKey - of the plan to add the jobstageId - of the stage to add the jobjobKeyString - of the job to add. May be full or partial job key.name - name of the jobdescription - description of the jobsuspended - sets the job suspended statusWebValidationExceptionpublic ErrorCollection validateJobForClone(@Nullable @Nullable String sourceJobKeyString, @NotNull @NotNull PlanKey chainKey, long stageId, @Nullable @Nullable String newJobKey, @Nullable @Nullable String name, @Nullable @Nullable String description, @Nullable @Nullable Boolean suspended) throws WebValidationException
JobServicevalidateJobForClone in interface JobServicesourceJobKeyString - key of the job to clone. Must be full job key.chainKey - key of the plan to add the new job to.stageId - id of the stage to add the new job to.newJobKey - key of the new job. May be full or partial job key.name - name of the new job.description - description of the new job.suspended - suspended state of the new job.WebValidationExceptionpublic ImmutableJob cloneJob(@NotNull @NotNull String sourceJobKeyString, @NotNull @NotNull PlanKey chainKey, long stageId, @NotNull @NotNull String newJobKeyString, @NotNull @NotNull String name, @Nullable @Nullable String description, boolean suspended) throws WebValidationException
JobServicecloneJob in interface JobServicesourceJobKeyString - key of the source job to copy. Must be full job key.chainKey - of the plan to add the new job.stageId - of the stage to add the new job.newJobKeyString - key to give to the new job. May be full or partial job key.name - The name of the cloned job.description - The description of the cloned job.suspended - The suspended state of the cloned job.WebValidationExceptionpublic void deleteJob(@NotNull
@NotNull PlanKey jobKey,
@NotNull
BambooClosures.Throwing1<ImmutableJob,WebValidationException>... runBefore)
throws WebValidationException
JobServicedeleteJob in interface JobServicejobKey - of jobrunBefore - code to execute after security and validation has passed but before the deletion occurs.WebValidationException@NotNull public @NotNull ErrorCollection validateJobForUpdate(@NotNull @NotNull PlanKey jobKey, @NotNull @NotNull String name, @Nullable @Nullable String description, boolean suspended, long stageId)
JobServicevalidateJobForUpdate in interface JobServicejobKey - of the job to updatename - new name of the jobdescription - new description of the jobsuspended - sets the job suspended status@NotNull public @NotNull ImmutableJob updateJob(@NotNull @NotNull PlanKey jobKey, @NotNull @NotNull String name, @Nullable @Nullable String description, boolean suspended, long stageId, @NotNull BambooClosures.Throwing1<ImmutableJob,WebValidationException>... runBefore) throws WebValidationException
JobServiceupdateJob in interface JobServicejobKey - of the job to updatename - new name of the jobdescription - new description of the jobsuspended - sets the job suspended statusstageId - new stage for the jobrunBefore - code to execute after security and validation has passed but before the update occurs.WebValidationExceptionCopyright © 2023 Atlassian Software Systems Pty Ltd. All rights reserved.