Package com.avoka.tm.svc
Class JobUpdater
- java.lang.Object
-
- com.avoka.tm.svc.JobUpdater
-
public class JobUpdater extends Object
Provides a job value object updater class.
Examples
Please find the job updater examples below.
Remove and Add a Job Property
This Groovy example shows how to update a job by removing and adding a jobProperty.
import com.avoka.tm.svc.* import com.avoka.tm.vo.* new JobUpdater(job) .removeProperty("fav food") .setProperty("sport","cycling") .update()
- Since:
- 17.10.0
-
-
Constructor Summary
Constructors Constructor Description JobUpdater()
Create a job updater.JobUpdater(Job job)
Create a job updater setting the job to update.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JobUpdater
addComment(Comment comment)
Add comment to the job.JobUpdater
removeProperty(String name)
Specify the property to remove from the job.JobUpdater
setId(Long id)
Set the id of the job to update.JobUpdater
setProperty(String name, String value)
Specify the property name and value to add or update on the job.void
update()
Update the identified job with the specified parameters.
-
-
-
Constructor Detail
-
JobUpdater
@FluentSecurityPermission(permissions="collaboration-job-edit") public JobUpdater()
Create a job updater.
-
JobUpdater
@FluentSecurityPermission(permissions="collaboration-job-edit") public JobUpdater(Job job)
Create a job updater setting the job to update.- Parameters:
job
- the Job to update.
-
-
Method Detail
-
setId
public JobUpdater setId(Long id)
Set the id of the job to update.- Parameters:
id
- the id (Long) of the job to update- Returns:
- the job updater
-
setProperty
public JobUpdater setProperty(String name, String value)
Specify the property name and value to add or update on the job.- Parameters:
name
- the property name (required)value
- the property value (required)- Returns:
- the job updater
-
removeProperty
public JobUpdater removeProperty(String name)
Specify the property to remove from the job.- Parameters:
name
- the property name to remove (required)- Returns:
- the job updater
-
addComment
public JobUpdater addComment(Comment comment)
Add comment to the job.- Parameters:
comment
- job comment- Returns:
- the job updater
- Since:
- 21.5.0
-
update
public void update()
Update the identified job with the specified parameters.
-
-