Package com.redwood.scheduler.api.model

Interface Script

All Superinterfaces:

BusinessKeyObject, JobDefinitionRelatedObject, JobDefinitionWithSource, Readable, Root, SchedulerEntity, SchedulerEntityComp

public interface Script
extends JobDefinitionWithSource, Readable

This covers all of the JobDefinitionTypes that run "natively" on a system.

Field Summary

Fields

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

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

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

Method Summary

Modifier and Type	Method	Description
Library	getLibrary()	Get the Library.
String	getRemoteRunAsUser()	Get the value for RemoteRunAsUser.
String	getRunAsUser()	Get the value for RunAsUser.
void	setLibrary(Library newLibrary)	Set the value for Library.
void	setRemoteRunAsUser(String newRemoteRunAsUser)	Set the value for RemoteRunAsUser.
void	setRunAsUser(String newRunAsUser)	Set the value for RunAsUser.

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

getBusinessKey

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

getJobDefinition, setJobDefinition

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

getSource, getStubSource, setSource

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

getCreationTime, getLastModificationTime, getLastModifierSubject

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 "Script" objects.

See Also:

Constant Field Values

TYPE

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

getRunAsUser

String getRunAsUser()

Get the value for RunAsUser. (A RedwoodExpression that specifies which user to run the script as.)

Returns:

the field

Throws:

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

getRemoteRunAsUser

String getRemoteRunAsUser()

Get the value for RemoteRunAsUser. (A RedwoodExpression that specifies which remote user to run the script as, for job definition types that have a remote user.)

Returns:

the field

Throws:

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

setRunAsUser

void setRunAsUser(String newRunAsUser)

Set the value for RunAsUser. (A RedwoodExpression that specifies which user to run the script as.) This value is optional.

Parameters:

newRunAsUser - the new value for RunAsUser.

Throws:

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

setRemoteRunAsUser

void setRemoteRunAsUser(String newRemoteRunAsUser)

Set the value for RemoteRunAsUser. (A RedwoodExpression that specifies which remote user to run the script as, for job definition types that have a remote user.) This value is optional.

Parameters:

newRemoteRunAsUser - the new value for RemoteRunAsUser.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a 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 script depends upon. If this is null, then the object cannot be persisted.