Package com.avoka.fc.core.entity

Class JobStep

java.lang.Object

org.apache.cayenne.PersistentObject

org.apache.cayenne.BaseDataObject

org.apache.cayenne.CayenneDataObject

com.avoka.core.entity.BaseEntity

com.avoka.fc.core.entity.auto._JobStep

com.avoka.fc.core.entity.JobStep

All Implemented Interfaces:

IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating

public class JobStep
extends _JobStep

Provides a Collaboration Job Step entity.

Since:

4.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JobStep.ActionsComparator	Provides a JobStep Actions Comparator.

Field Summary

Fields

Modifier and Type	Field	Description
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.
static final String[]	STATUS_VALUES	The valid Job Step status values.
static final String	TYPE_ENDPOINT	The "endpoint" step type.

Fields inherited from class com.avoka.fc.core.entity.auto._JobStep

ALL_FORMS_EDITABLE_FLAG, ALL_FORMS_EDITABLE_FLAG_PROPERTY, CURRENT_ACTION, CURRENT_ACTION_PROPERTY, CURRENT_STEP_JOB, CURRENT_STEP_JOB_PROPERTY, DYNAMIC_PRE_CONDITIONS_FLAG, DYNAMIC_PRE_CONDITIONS_FLAG_PROPERTY, EXPIRY_SERVICE, EXPIRY_SERVICE_PROPERTY, JOB, JOB_ACTIONS, JOB_ACTIONS_PROPERTY, JOB_PROPERTY, JOB_STEP_OID_PK_COLUMN, NAME, NAME_PROPERTY, NEXT_STEP_NAME, NEXT_STEP_NAME_PROPERTY, REDIRECT_NEXT_FLAG, REDIRECT_NEXT_FLAG_PROPERTY, SHARE_EXTRACT_DATA_FLAG, SHARE_EXTRACT_DATA_FLAG_PROPERTY, SHARE_FORM_DATA_FLAG, SHARE_FORM_DATA_FLAG_PROPERTY, SHOW_PREVIOUS_FORMS_FLAG, SHOW_PREVIOUS_FORMS_FLAG_PROPERTY, STATUS, STATUS_PROPERTY, TIME_COMPLETION_SCHEDULED, TIME_COMPLETION_SCHEDULED_PROPERTY, TIME_CREATED, TIME_CREATED_PROPERTY, TIME_FINISHED, TIME_FINISHED_PROPERTY, TYPE, TYPE_PROPERTY

Fields inherited from class com.avoka.core.entity.BaseEntity

ID_PROPERTY

Fields inherited from class org.apache.cayenne.CayenneDataObject

values

Fields inherited from class org.apache.cayenne.BaseDataObject

snapshotVersion

Fields inherited from class org.apache.cayenne.PersistentObject

objectContext, objectId, persistenceState

Fields inherited from interface org.apache.cayenne.DataObject

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor	Description
JobStep()

Method Summary

Modifier and Type	Method	Description
Map<String,JobAction>	getJobActionMap()
List<JobAction>	getOrderedJobActions()
boolean	hasScheduledCompletionExpired()	Return true if the step has expired or false otherwise.
boolean	isStatusCancelled()
boolean	isStatusCompleted()
boolean	isStatusExpired()
boolean	isStatusInProgress()
boolean	isTypeEndpoint()
void	setTimeCompletionScheduled(Date timeCompletionScheduled)	Set the timeCompletionScheduled value.
void	setTimeCreated(Date timeCreated)	Set the timeCreated value.
void	setTimeFinished(Date timeFinished)	Set the timeFinished value.
String	toString()

Methods inherited from class com.avoka.fc.core.entity.auto._JobStep

addToJobActions, getCurrentAction, getCurrentStepJob, getExpiryService, getJob, getJobActions, getName, getNextStepName, getStatus, getTimeCompletionScheduled, getTimeCreated, getTimeFinished, getType, isAllFormsEditableFlag, isDynamicPreConditionsFlag, isRedirectNextFlag, isShareExtractDataFlag, isShareFormDataFlag, isShowPreviousFormsFlag, removeFromJobActions, setAllFormsEditableFlag, setCurrentAction, setCurrentStepJob, setDynamicPreConditionsFlag, setExpiryService, setJob, setName, setNextStepName, setRedirectNextFlag, setShareExtractDataFlag, setShareFormDataFlag, setShowPreviousFormsFlag, setStatus, setType

Methods inherited from class com.avoka.core.entity.BaseEntity

appendProperties, getId, getValuesMap, isNew, setId

Methods inherited from class org.apache.cayenne.CayenneDataObject

makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState

Methods inherited from class org.apache.cayenne.BaseDataObject

addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized

Methods inherited from class org.apache.cayenne.PersistentObject

getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Field Details

STATUS_IN_PROGRESS

public static final String STATUS_IN_PROGRESS

The Job Step "In Progress" 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_CANCELLED

public static final String STATUS_CANCELLED

The Job Step "Cancelled" 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_VALUES

public static final String[] STATUS_VALUES

The valid Job Step status values.

TYPE_ENDPOINT

public static final String TYPE_ENDPOINT

The "endpoint" step type.

See Also:

• Constant Field Values

Constructor Details

JobStep

public JobStep()

Method Details

isStatusCancelled

public boolean isStatusCancelled()

Returns:

true if the status is "Cancelled"

isStatusCompleted

public boolean isStatusCompleted()

Returns:

true if the status is "Completed"

isStatusExpired

public boolean isStatusExpired()

Returns:

true if the status is "Expired"

isStatusInProgress

public boolean isStatusInProgress()

Returns:

true if the status is "In Progress"

isTypeEndpoint

public boolean isTypeEndpoint()

Returns:

true is "endpoint" step type

hasScheduledCompletionExpired

public boolean hasScheduledCompletionExpired()

Return true if the step has expired or false otherwise.

Returns:

true if the step has expired or false otherwise.

getJobActionMap

public Map<String,JobAction> getJobActionMap()

Returns:

an map of Job Actions keyed on job action name.

getOrderedJobActions

public List<JobAction> getOrderedJobActions()

Returns:

the list of job actions ordered by id.

toString

public String toString()

Overrides:

toString in class BaseEntity

Returns:

the string representation of this object.

setTimeFinished

public void setTimeFinished(Date timeFinished)

Description copied from class: _JobStep

Set the timeFinished value.

Overrides:

setTimeFinished in class _JobStep

Parameters:

timeFinished - the timeFinished value to set

setTimeCreated

public void setTimeCreated(Date timeCreated)

Description copied from class: _JobStep

Set the timeCreated value.

Overrides:

setTimeCreated in class _JobStep

Parameters:

timeCreated - the timeCreated value to set

setTimeCompletionScheduled

public void setTimeCompletionScheduled(Date timeCompletionScheduled)

Description copied from class: _JobStep

Set the timeCompletionScheduled value.

Overrides:

setTimeCompletionScheduled in class _JobStep

Parameters:

timeCompletionScheduled - the timeCompletionScheduled value to set