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 LongcurrentJobActionIdThe current job action id (PK).LongexpiryServiceIdThe job step expiry service id (PK).LongidThe job step record (PK).booleanisAllFormsEditableThe all forms editable option.booleanisDynamicPreConditionsThe dynamic pre-conditions option.booleanisShareExtractDataThe share form data extracts between step forms option.booleanisShareFormDataThe share form XML data between step forms option.booleanisShowPreviousFormsThe show previous step forms option.List<JobAction>jobActionsThe job step actions.StringnameThe job step name.StringnextStepNameThe next job step name.StringstatusThe job step status.static StringSTATUS_CANCELLEDThe job step "Cancelled" status.static StringSTATUS_COMPLETEDThe job step "Completed" status.static StringSTATUS_EXPIREDThe job step "Expired" status.static StringSTATUS_IN_PROGRESSThe job step "In Progress" status.DatetimeCompletionScheduledThe time the job step is scheduled to be completed.DatetimeCreatedThe time the job step was created.DatetimeFinishedThe time the job step was finished.StringtypeThe job step type.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LonggetCurrentJobActionId()The current job action id (PK).LonggetExpiryServiceId()The job step expiry service id (PK).LonggetId()The job step record (PK).List<JobAction>getJobActions()The job step actions.StringgetName()The job step name.StringgetNextStepName()The next job step name.StringgetStatus()The job step status.DategetTimeCompletionScheduled()The time the job step is scheduled to be completed.DategetTimeCreated()The time the job step was created.DategetTimeFinished()The time the job step was finished.StringgetType()The job step type.booleanisAllFormsEditable()The all forms editable option.booleanisDynamicPreConditions()The dynamic pre-conditions option.booleanisShareExtractData()The share form data extracts between step forms option.booleanisShareFormData()The share form XML data between step forms option.booleanisShowPreviousForms()The show previous step forms option.StringtoString()
-
-
-
Field Detail
-
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
-
id
public final Long id
The job step record (PK).
-
name
public final String name
The job step name.
-
type
public final String type
The job step type.
-
status
public final String status
The job step status.
-
currentJobActionId
public final Long currentJobActionId
The current job action id (PK).
-
expiryServiceId
public final Long expiryServiceId
The job step expiry service id (PK).
-
isAllFormsEditable
public final boolean isAllFormsEditable
The all forms editable option.
-
isDynamicPreConditions
public final boolean isDynamicPreConditions
The dynamic pre-conditions option.
-
isShareExtractData
public final boolean isShareExtractData
The share form data extracts between step forms option.
-
isShareFormData
public final boolean isShareFormData
The share form XML data between step forms option.
-
isShowPreviousForms
public final boolean isShowPreviousForms
The show previous step forms option.
-
nextStepName
public final String nextStepName
The next job step name.
-
timeCreated
public final Date timeCreated
The time the job step was created.
-
timeCompletionScheduled
public final Date timeCompletionScheduled
The time the job step is scheduled to be completed.
-
timeFinished
public final Date timeFinished
The time the job step was finished.
-
-
Constructor Detail
-
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 submission entity fields (required)- Since:
- 5.1.4
-
-
Method Detail
-
toString
public String toString()
-
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.
-
-