Package com.avoka.tm.vo

Class JobStep

java.lang.Object

com.avoka.tm.vo.JobStep

public class JobStep
extends Object

Provide a Job Step value object class.

Since:

5.0.0

Field Summary

Fields

Modifier and Type	Field	Description
List<JobAction>	jobActions	The job step actions.
static final String	STATUS_CANCELLED	The job step "Cancelled" status.
static final String	STATUS_COMPLETED	The job step "Completed" status.
static final String	STATUS_EXPIRED	The job step "Expired" status.
static final String	STATUS_IN_PROGRESS	The job step "In Progress" status.

Constructor Summary

Constructors

Constructor	Description
JobStep()
JobStep(com.avoka.fc.core.entity.JobStep jobStep)	Create a Job Step value object with the given job step entity parameter.
JobStep(Map fields)	Create a unit testing JobStep value object with the given fields.

Method Summary

Modifier and Type	Method	Description
Long	getCurrentJobActionId()	The current job action id (PK).
Long	getExpiryServiceId()	The job step expiry service id (PK).
Long	getId()	The job step record (PK).
List<JobAction>	getJobActions()	The job step actions.
String	getName()	The job step name.
String	getNextStepName()	The next job step name.
String	getStatus()	The job step status.
Date	getTimeCompletionScheduled()	The time the job step is scheduled to be completed.
Date	getTimeCreated()	The time the job step was created.
Date	getTimeFinished()	The time the job step was finished.
String	getType()	The job step type.
boolean	isAllFormsEditable()	The all forms editable option.
boolean	isDynamicPreConditions()	The dynamic pre-conditions option.
boolean	isShareExtractData()	The share form data extracts between step forms option.
boolean	isShareFormData()	The share form XML data between step forms option.
boolean	isShowPreviousForms()	The show previous step forms option.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

STATUS_CANCELLED

public static final String STATUS_CANCELLED

The job step "Cancelled" status.

See Also:

• Constant Field Values

STATUS_COMPLETED

public static final String STATUS_COMPLETED

The job step "Completed" status.

See Also:

• Constant Field Values

STATUS_EXPIRED

public static final String STATUS_EXPIRED

The job step "Expired" status.

See Also:

• Constant Field Values

STATUS_IN_PROGRESS

public static final String STATUS_IN_PROGRESS

The job step "In Progress" status.

See Also:

• Constant Field Values

jobActions

public List<JobAction> jobActions

The job step actions.

Constructor Details

JobStep

public JobStep()

JobStep

public JobStep(com.avoka.fc.core.entity.JobStep jobStep)

Create a Job Step value object with the given job step entity parameter.

Parameters:

jobStep - the job step entity parameter (required)

JobStep

public JobStep(Map fields)

Create a unit testing JobStep value object with the given fields.

Parameters:

fields - the job step entity fields (required)

Since:

5.1.4

Method Details

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of the object.

getId

public Long getId()

The job step record (PK).

getName

public String getName()

The job step name.

getType

public String getType()

The job step type.

getStatus

public String getStatus()

The job step status.

getCurrentJobActionId

public Long getCurrentJobActionId()

The current job action id (PK).

getExpiryServiceId

public Long getExpiryServiceId()

The job step expiry service id (PK).

isAllFormsEditable

public boolean isAllFormsEditable()

The all forms editable option.

isDynamicPreConditions

public boolean isDynamicPreConditions()

The dynamic pre-conditions option.

isShareExtractData

public boolean isShareExtractData()

The share form data extracts between step forms option.

isShareFormData

public boolean isShareFormData()

The share form XML data between step forms option.

isShowPreviousForms

public boolean isShowPreviousForms()

The show previous step forms option.

getNextStepName

public String getNextStepName()

The next job step name.

getTimeCreated

public Date getTimeCreated()

The time the job step was created.

getTimeCompletionScheduled

public Date getTimeCompletionScheduled()

The time the job step is scheduled to be completed.

getTimeFinished

public Date getTimeFinished()

The time the job step was finished.

getJobActions

public List<JobAction> getJobActions()

The job step actions.