Package com.redwood.scheduler.api.model

Interface JobDefinitionAction

All Superinterfaces:

ActionEnableObject, ActionSubjectObject, BusinessKeyObject, Detail, ExecutableSchedulerEntity, Readable, SchedulerEntity, SchedulerEntityAction, SchedulerEntityComp

public interface JobDefinitionAction
extends SchedulerEntityAction, ExecutableSchedulerEntity, ActionEnableObject, BusinessKeyObject, Readable

Action to execute for jobs based on this job definition.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobDefinitionAction" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<JobDefinitionAction>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static com.redwood.scheduler.infrastructure.logging.Versions	VERSION_JOBDEFINITIONACTION

Fields inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

COPYRIGHT_MESSAGE_BKO, ID_BKO

Fields inherited from interface com.redwood.scheduler.api.model.Detail

VERSION_DETAIL

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntityAction

VERSION_SCHEDULERENTITYACTION

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
JobDefinition	getJobDefinition()	Get the JobDefinition.
Library	getLibrary()	Get the Library.
JobDefinitionActionType	getType()	Get the value for Type.
Set<Variable>	getVariables()	Get the Set of Variables related to JobDefinitionAction objects.
void	setLibrary(Library newLibrary)	Set the value for Library.
void	setType(JobDefinitionActionType newType)	Set the value for Type.

Methods inherited from interface com.redwood.scheduler.api.model.interfaces.ActionEnableObject

getErrorNameEN, isEnabled, setEnabled

Methods inherited from interface com.redwood.scheduler.api.model.interfaces.ActionSubjectObject

getActionSubject, getActionSubjectUniqueId

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntityAction

getActionSubject, getSource, getStubSource, isEnabled, setActionSubject, setEnabled, setSource

Field Detail

VERSION_JOBDEFINITIONACTION

static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_JOBDEFINITIONACTION

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "JobDefinitionAction" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<JobDefinitionAction> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getType

JobDefinitionActionType getType()

Get the value for Type. (The type of the action.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setType

void setType(JobDefinitionActionType newType)

Set the value for Type. (The type of the action.) This value is mandatory.

Parameters:

newType - the new value for Type. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getVariables

Set<Variable> getVariables()

Get the Set of Variables related to JobDefinitionAction objects.

Specified by:

getVariables in interface ExecutableSchedulerEntity

Returns:

Set of Variable for JobDefinitionAction.

getJobDefinition

JobDefinition getJobDefinition()

Get the JobDefinition.

Returns:

JobDefinition

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

getLibrary

Library getLibrary()

Get the Library.

Returns:

Library

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setLibrary

void setLibrary(Library newLibrary)

Set the value for Library. This value is mandatory.

Parameters:

newLibrary - is the object to set Library to. The library that the SchedulerEntityAction depends upon. If this is null, then the object cannot be persisted.