Method Detailcommit() Saves payload back to the storage layer for this job. Since: 11-03-2016 String getId() Returns the job id. Max length is 30. Returns: String Since: 12-21-2012 String getName() Returns the job name. Returns: String Since: 12-21-2012 Payload getPayload() Returns the payload for the job. This method always returns a non null payload, even if the payload itself has no data. Returns: Payload Since: 12-21-2012 int getPriority() Returns the job priority. Returns: int Since: 04-10-2026 int getRunCount() Returns the number of times this job has run. Returns: int Since: 11-03-2016 Date getRunDate() Returns the date the job ran or null if it has not yet ran. Returns: Date Since: 01-07-2013 Date getScheduleDate() Returns the date the job is scheduled to run. Returns: Date Since: 01-07-2013 String getStatus() Returns the job status. Status will be New, Finished, Queued, Running, Rescheduled, Error, Deleted, or Unknown Returns: String Since: 01-07-2013 remove() Removes this job from the job queue (deletes it) effective at the end of the workflow cycle. Since: 01-07-2013 reschedule(Date date) Reschedules this job to run again at the date and time specified. The time must be in the future. Great care should be taken in using this method since usually you run a job once and forget about it. Priority jobs cannot be rescheduled with the same priority.
Parameters:
Since: 11-03-2016 boolean rescheduleIfUnique(Date date) Reschedules this job, but only if no other job for this pal with the same name already has a pending status (New, Rescheduled or Queued). Returns true if the job was rescheduled, or false if a matching job already exists, in which case this job is left as-is (call remove() or let it finish normally). This check is cluster safe, but it is not finalized until commit() (or the end of the workflow) actually persists the reschedule.
Parameters:
Returns: boolean Since: 09-08-2026 setPayload(Payload payload) Sets the job's payload. For this to persist, call commit(). Max serialized payload is approx 16MB.
Parameters:
Since: 11-03-2016 String toString() Returns a description of this object. Returns: String Since: 12-21-2012 |
|||||||||||||||||||||||||||||||
| Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. | API Date: Sep 09, 2026 06:04 PM |