Class Job

public class Job
extends java.lang.Object

Provide a Job value object class.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	clientCode	The organization client code.
java.lang.Long	controllerServiceId	The job controller service id.
java.lang.Long	currentJobStepId	The current job step id (PK).
java.lang.Long	id	The job record id (PK).
java.lang.String	jobKey	The job key.
java.util.List<JobStep>	jobSteps	The list of job steps.
java.lang.String	name	The job name.
java.lang.Long	orgId	The organization id (PK).
java.util.Map<java.lang.String,​java.lang.String>	propertyMap	The job property map.
java.lang.String	referenceNumber	The job reference number.
java.lang.String	status	The job status.
static java.lang.String	STATUS_CANCELLED	The job "Cancelled" status.
static java.lang.String	STATUS_COMPLETED	The job "Completed" status.
static java.lang.String	STATUS_ERROR	The job "Error" status.
static java.lang.String	STATUS_EXPIRED	The job "Expired" status.
static java.lang.String	STATUS_IN_PROGRESS	The job "In Progress" status.
static java.lang.String	STATUS_PAUSED	The job "Paused" status.
java.util.Date	timeCompletionScheduled	The time the job is scheduled for completion.
java.util.Date	timeCreated	The time the job was created.
java.util.Date	timeFinished	The time the job was finished.
java.util.Date	timeLastProcessed	The time the job was last processed.
java.util.Date	timePurgeScheduled	The time the job is scheduled to be purged.
java.util.List<java.lang.Long>	txnIdList	The list of job transaction ids.

Constructor Summary

Constructors

Constructor	Description
Job​(com.avoka.fc.core.entity.Job job)	Create a Job value object with the given job entity parameter.
Job​(java.util.Map fields)	Create a unit testing Job value object with the given fields.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_CANCELLED

public static final java.lang.String STATUS_CANCELLED The job "Cancelled" status.

See Also:

Constant Field Values

STATUS_COMPLETED

public static final java.lang.String STATUS_COMPLETED The job "Completed" status.

See Also:

Constant Field Values

STATUS_ERROR

public static final java.lang.String STATUS_ERROR The job "Error" status.

See Also:

Constant Field Values

STATUS_EXPIRED

public static final java.lang.String STATUS_EXPIRED The job "Expired" status.

See Also:

Constant Field Values

STATUS_IN_PROGRESS

public static final java.lang.String STATUS_IN_PROGRESS The job "In Progress" status.

See Also:

Constant Field Values

STATUS_PAUSED

public static final java.lang.String STATUS_PAUSED The job "Paused" status.

See Also:

Constant Field Values

id

public final java.lang.Long id The job record id (PK).

name

public final java.lang.String name The job name.

orgId

public final java.lang.Long orgId The organization id (PK).

clientCode

public final java.lang.String clientCode The organization client code.

controllerServiceId

public final java.lang.Long controllerServiceId The job controller service id.

jobKey

public final java.lang.String jobKey The job key.

referenceNumber

public final java.lang.String referenceNumber The job reference number.

status

public final java.lang.String status The job status.

currentJobStepId

public final java.lang.Long currentJobStepId The current job step id (PK).

timeCompletionScheduled

public final java.util.Date timeCompletionScheduled The time the job is scheduled for completion.

timeCreated

public final java.util.Date timeCreated The time the job was created.

timeFinished

public final java.util.Date timeFinished The time the job was finished.

timeLastProcessed

public final java.util.Date timeLastProcessed The time the job was last processed.

timePurgeScheduled

public final java.util.Date timePurgeScheduled The time the job is scheduled to be purged.

txnIdList

public java.util.List<java.lang.Long> txnIdList The list of job transaction ids.

jobSteps

public java.util.List<JobStep> jobSteps The list of job steps.

propertyMap

public final java.util.Map<java.lang.String,​java.lang.String> propertyMap The job property map.

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​(java.util.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.