Package com.avoka.tm.vo
Class Job
- java.lang.Object
-
- com.avoka.tm.vo.Job
-
public class Job extends Object
Provide a Job value object class.- Since:
- 5.0.0
-
-
Field Summary
Fields Modifier and Type Field Description StringclientCodeThe organization client code.LongcontrollerServiceIdThe job controller service id.LongcurrentJobStepIdThe current job step id (PK).LongidThe job record id (PK).StringjobKeyThe job key.List<JobStep>jobStepsThe list of job steps.StringnameThe job name.LongorgIdThe organization id (PK).Map<String,String>propertyMapThe job property map.StringreferenceNumberThe job reference number.StringstatusThe job status.static StringSTATUS_CANCELLEDThe job "Cancelled" status.static StringSTATUS_COMPLETEDThe job "Completed" status.static StringSTATUS_ERRORThe job "Error" status.static StringSTATUS_EXPIREDThe job "Expired" status.static StringSTATUS_IN_PROGRESSThe job "In Progress" status.static StringSTATUS_PAUSEDThe job "Paused" status.DatetimeCompletionScheduledThe time the job is scheduled for completion.DatetimeCreatedThe time the job was created.DatetimeFinishedThe time the job was finished.DatetimeLastProcessedThe time the job was last processed.DatetimePurgeScheduledThe time the job is scheduled to be purged.List<Long>txnIdListThe list of job transaction ids.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetClientCode()The organization client code.LonggetControllerServiceId()The job controller service id.LonggetCurrentJobStepId()The current job step id (PK).LonggetId()The job record id (PK).StringgetJobKey()The job key.List<JobStep>getJobSteps()The list of job steps.StringgetName()The job name.LonggetOrgId()The organization id (PK).Map<String,String>getPropertyMap()The job property map.StringgetReferenceNumber()The job reference number.StringgetStatus()The job status.DategetTimeCompletionScheduled()The time the job is scheduled for completion.DategetTimeCreated()The time the job was created.DategetTimeFinished()The time the job was finished.DategetTimeLastProcessed()The time the job was last processed.DategetTimePurgeScheduled()The time the job is scheduled to be purged.List<Long>getTxnIdList()The list of job transaction ids.StringtoString()
-
-
-
Field Detail
-
STATUS_CANCELLED
public static final String STATUS_CANCELLED
The job "Cancelled" status.- See Also:
- Constant Field Values
-
STATUS_COMPLETED
public static final String STATUS_COMPLETED
The job "Completed" status.- See Also:
- Constant Field Values
-
STATUS_ERROR
public static final String STATUS_ERROR
The job "Error" status.- See Also:
- Constant Field Values
-
STATUS_EXPIRED
public static final String STATUS_EXPIRED
The job "Expired" status.- See Also:
- Constant Field Values
-
STATUS_IN_PROGRESS
public static final String STATUS_IN_PROGRESS
The job "In Progress" status.- See Also:
- Constant Field Values
-
STATUS_PAUSED
public static final String STATUS_PAUSED
The job "Paused" status.- See Also:
- Constant Field Values
-
id
public final Long id
The job record id (PK).
-
name
public final String name
The job name.
-
orgId
public final Long orgId
The organization id (PK).
-
clientCode
public final String clientCode
The organization client code.
-
controllerServiceId
public final Long controllerServiceId
The job controller service id.
-
jobKey
public final String jobKey
The job key.
-
referenceNumber
public final String referenceNumber
The job reference number.
-
status
public final String status
The job status.
-
currentJobStepId
public final Long currentJobStepId
The current job step id (PK).
-
timeCompletionScheduled
public final Date timeCompletionScheduled
The time the job is scheduled for completion.
-
timeCreated
public final Date timeCreated
The time the job was created.
-
timeFinished
public final Date timeFinished
The time the job was finished.
-
timeLastProcessed
public final Date timeLastProcessed
The time the job was last processed.
-
timePurgeScheduled
public final Date timePurgeScheduled
The time the job is scheduled to be purged.
-
-
Constructor Detail
-
Job
public Job(com.avoka.fc.core.entity.Job job)
Create a Job value object with the given job entity parameter.- Parameters:
job- the job entity parameter (required)
-
Job
public Job(Map fields)
Create a unit testing Job value object with the given fields.- Parameters:
fields- the submission entity fields (required)- Since:
- 5.1.4
-
-
Method Detail
-
toString
public String toString()
-
getId
public Long getId()
The job record id (PK).
-
getName
public String getName()
The job name.
-
getOrgId
public Long getOrgId()
The organization id (PK).
-
getClientCode
public String getClientCode()
The organization client code.
-
getControllerServiceId
public Long getControllerServiceId()
The job controller service id.
-
getJobKey
public String getJobKey()
The job key.
-
getReferenceNumber
public String getReferenceNumber()
The job reference number.
-
getStatus
public String getStatus()
The job status.
-
getCurrentJobStepId
public Long getCurrentJobStepId()
The current job step id (PK).
-
getTimeCompletionScheduled
public Date getTimeCompletionScheduled()
The time the job is scheduled for completion.
-
getTimeCreated
public Date getTimeCreated()
The time the job was created.
-
getTimeFinished
public Date getTimeFinished()
The time the job was finished.
-
getTimeLastProcessed
public Date getTimeLastProcessed()
The time the job was last processed.
-
getTimePurgeScheduled
public Date getTimePurgeScheduled()
The time the job is scheduled to be purged.
-
-