Package com.redwood.scheduler.api.model

Interface Trigger

All Superinterfaces:

ActionEnableObject, ActionSubjectObject, ApplicationObject, BusinessKeyObject, ExecutableSchedulerEntity, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface Trigger
extends UniqueNamedApplicationObject, ExecutableSchedulerEntity, ActionEnableObject, Readable

A library dependency for a script.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "Trigger" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<Trigger>	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
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
Subject	getActionSubject()	Get the ActionSubject.
Long	getExecutionOrder()	Get the value for ExecutionOrder.
Library	getLibrary()	Get the Library.
LogLevel	getLogLevel()	Get the value for LogLevel.
Long	getMaxBackupFiles()	Get the value for MaxBackupFiles.
Long	getMaxLogSize()	Get the value for MaxLogSize.
String	getSource()	Get the value for Source.
String	getStubSource()	Get the value for StubSource.
TriggerPoint	getTriggerPoint()	Get the value for TriggerPoint.
Validity	getValidity()	Get the value for Validity.
Set<Variable>	getVariables()	Get the Set of Variables related to Trigger objects.
boolean	isEnabled()	Get the value for Enabled.
boolean	isLogFileEnabled()	Get the value for LogFileEnabled.
void	setActionSubject(Subject newActionSubject)	Set the value for ActionSubject.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setExecutionOrder(Long newExecutionOrder)	Set the value for ExecutionOrder.
void	setLibrary(Library newLibrary)	Set the value for Library.
void	setLogFileEnabled(boolean newLogFileEnabled)	Set the value for LogFileEnabled.
void	setLogLevel(LogLevel newLogLevel)	Set the value for LogLevel.
void	setMaxBackupFiles(Long newMaxBackupFiles)	Set the value for MaxBackupFiles.
void	setMaxLogSize(Long newMaxLogSize)	Set the value for MaxLogSize.
void	setSource(String newSource)	Set the value for Source.
void	setTriggerPoint(TriggerPoint newTriggerPoint)	Set the value for TriggerPoint.

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

getParentApplication, setParentApplication

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

getBusinessKey

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

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

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

createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<Trigger> TYPE

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

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

getTriggerPoint

TriggerPoint getTriggerPoint()

Get the value for TriggerPoint. (The point where the trigger is linked to.) 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 the trigger is 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.

getLogLevel

LogLevel getLogLevel()

Get the value for LogLevel. (What is the Log Level when logging from the trigger.) 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.

getMaxLogSize

Long getMaxLogSize()

Get the value for MaxLogSize. (What is the maximum size of each log file, in MB.) 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.

getMaxBackupFiles

Long getMaxBackupFiles()

Get the value for MaxBackupFiles. (What is the maximum number of backup files to keep.) 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.

isLogFileEnabled

boolean isLogFileEnabled()

Get the value for LogFileEnabled. (Whether the trigger's log file is enabled or not.)

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.

getExecutionOrder

Long getExecutionOrder()

Get the value for ExecutionOrder. (The order of execution of the triggers.) 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.

getSource

String getSource()

Get the value for Source. (The full source of the Trigger.)

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 trigger.) 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.

getValidity

Validity getValidity()

Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) 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.

setTriggerPoint

void setTriggerPoint(TriggerPoint newTriggerPoint)

Set the value for TriggerPoint. (The point where the trigger is linked to.) This value is mandatory.

Parameters:

newTriggerPoint - the new value for TriggerPoint. 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 the trigger is 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.

setLogLevel

void setLogLevel(LogLevel newLogLevel)

Set the value for LogLevel. (What is the Log Level when logging from the trigger.) This value is mandatory.

Parameters:

newLogLevel - the new value for LogLevel. 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.

setMaxLogSize

void setMaxLogSize(Long newMaxLogSize)

Set the value for MaxLogSize. (What is the maximum size of each log file, in MB.) This value is mandatory.

Parameters:

newMaxLogSize - the new value for MaxLogSize. 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.

setMaxBackupFiles

void setMaxBackupFiles(Long newMaxBackupFiles)

Set the value for MaxBackupFiles. (What is the maximum number of backup files to keep.) This value is mandatory.

Parameters:

newMaxBackupFiles - the new value for MaxBackupFiles. 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.

setLogFileEnabled

void setLogFileEnabled(boolean newLogFileEnabled)

Set the value for LogFileEnabled. (Whether the trigger's log file is enabled or not.)

Parameters:

newLogFileEnabled - the new value for LogFileEnabled.

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.

setExecutionOrder

void setExecutionOrder(Long newExecutionOrder)

Set the value for ExecutionOrder. (The order of execution of the triggers.) This value is mandatory.

Parameters:

newExecutionOrder - the new value for ExecutionOrder. 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.

setSource

void setSource(String newSource)

Set the value for Source. (The full source of the Trigger.) This value is optional.

Parameters:

newSource - the new value for Source.

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 Trigger objects.

Specified by:

getVariables in interface ExecutableSchedulerEntity

Returns:

Set of Variable for Trigger.

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.

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.

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

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?

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.