Package com.redwood.scheduler.api.model

Interface JobDefinitionTypeAction

All Superinterfaces:

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

public interface JobDefinitionTypeAction
extends Detail, ExecutableSchedulerEntity, ActionEnableObject, BusinessKeyObject, Readable

Action to execute for jobs using this JobDefinitionType.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "JobDefinitionTypeAction" 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<JobDefinitionTypeAction>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

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

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
Subject	getActionSubject()	Get the ActionSubject.
JobDefinitionType	getJobDefinitionType()	Get the JobDefinitionType.
Library	getLibrary()	Get the Library.
String	getSource()	Get the value for Source.
String	getStubSource()	Get the value for StubSource.
JobDefinitionTypeActionType	getType()	Get the value for Type.
Set<Variable>	getVariables()	Get the Set of Variables related to JobDefinitionTypeAction objects.
boolean	isEnabled()	Get the value for Enabled.
void	setActionSubject(Subject newActionSubject)	Set the value for ActionSubject.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setLibrary(Library newLibrary)	Set the value for Library.
void	setSource(String newSource)	Set the value for Source.
void	setType(JobDefinitionTypeActionType newType)	Set the value for Type.

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

getErrorNameEN

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

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

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<JobDefinitionTypeAction> 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

JobDefinitionTypeActionType 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:

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

isEnabled

boolean isEnabled()

Get the value for Enabled. (Whether this action is currently enabled or not.)

Specified by:

isEnabled in interface ActionEnableObject

Returns:

the field

Throws:

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

getSource

String getSource()

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

Returns:

the field

Throws:

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

getStubSource

String getStubSource()

Get the value for StubSource. (The source for the stub 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:

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

setType

void setType(JobDefinitionTypeActionType 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:

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

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Whether this action is currently enabled or not.)

Specified by:

setEnabled in interface ActionEnableObject

Parameters:

newEnabled - the new value for Enabled.

Throws:

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

setSource

void setSource(String newSource)

Set the value for Source. (The source of this JobDefinitionTypeAction) This value is mandatory.

Parameters:

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

Throws:

com.redwood.scheduler.api.exception.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 JobDefinitionTypeAction objects.

Specified by:

getVariables in interface ExecutableSchedulerEntity

Returns:

Set of Variable for JobDefinitionTypeAction.

getJobDefinitionType

JobDefinitionType getJobDefinitionType()

Get the JobDefinitionType.

Returns:

JobDefinitionType

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

getActionSubject

Subject getActionSubject()

Get the ActionSubject.

Specified by:

getActionSubject in interface ActionSubjectObject

Returns:

ActionSubject

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.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:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setActionSubject

void setActionSubject(Subject newActionSubject)

Set the value for ActionSubject. This value is optional.

Parameters:

newActionSubject - is the object to set ActionSubject to. Who does this action execute as?

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 JobDefinitionTypeAction depends upon. If this is null, then the object cannot be persisted.