Package com.redwood.scheduler.api.model

Interface JobDefinitionForm

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface JobDefinitionForm
extends NamedDetailObject, BusinessKeyObject, Readable

A form defined for a job definition Forms enable you to define custom windows to submit job definitions or edit jobs.

Field Summary

Fields

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

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.NamedDetailObject

VERSION_NAMEDDETAILOBJECT

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.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
String	getForm()	Get the value for Form.
JobDefinition	getJobDefinition()	Get the JobDefinition.
void	setForm(String newForm)	Set the value for Form.

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

getBusinessKey

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

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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

VERSION_JOBDEFINITIONFORM

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

OBJECT_TYPE

static final String OBJECT_TYPE

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

See Also:

Constant Field Values

TYPE

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

getForm

String getForm()

Get the value for Form. (The form definition as json) 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.

setForm

void setForm(String newForm)

Set the value for Form. (The form definition as json) This value is mandatory.

Parameters:

newForm - the new value for Form. 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.

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.