Package com.redwood.scheduler.api.model

Interface Library

All Superinterfaces:

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

public interface Library
extends LibraryComp, UniqueNamedApplicationObject, ExecutableSchedulerEntity, Readable

A library dependency for a script.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CUSTOM	The name of the Custom library that all scripts and libraries depend upon.
static String	NONE	The name of the None library that is not editable that all scripts and libraries depend upon by default.
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "Library" 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<Library>	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.
JARFile	createJARFile()	Create a new JARFile linked to this object.
LibrarySource	createLibrarySource()	Create a new LibrarySource linked to this object.
RELEntryPoint	createRELEntryPoint()	Create a new RELEntryPoint linked to this object.
RWIterable<AlertEscalationAction>	getAlertEscalationActions()	Get an RWIterable over an ordered collection of AlertEscalationActions.
RWIterable<AlertSourceAction>	getAlertSourceActions()	Get an RWIterable over an ordered collection of AlertSourceActions.
RWIterable<Database>	getDatabases()	Get an RWIterable over an ordered collection of Databases.
RWIterable<EmailAlertGatewayAction>	getEmailAlertGatewayActions()	Get an RWIterable over an ordered collection of EmailAlertGatewayActions.
RWIterable<ExtensionPoint>	getExtensionPoints()	Get an RWIterable over an ordered collection of ExtensionPoints.
RWIterable<ImportAction>	getImportActions()	Get an RWIterable over an ordered collection of ImportActions.
JARFile	getJARFileByName(String name)	Get the JARFile by LibraryName.
RWIterable<JARFile>	getJARFiles()	Get an RWIterable over an ordered collection of JARFiles.
RWIterable<JobDefinitionAction>	getJobDefinitionActions()	Get an RWIterable over an ordered collection of JobDefinitionActions.
RWIterable<JobDefinitionTypeAction>	getJobDefinitionTypeActions()	Get an RWIterable over an ordered collection of JobDefinitionTypeActions.
LibrarySource	getLibrarySourceByFQClassName(String fQClassName)	Get the LibrarySource by LibrarySourceFQClassName.
RWIterable<LibrarySource>	getLibrarySources()	Get an RWIterable over an ordered collection of LibrarySources.
RWIterable<PeriodFunction>	getPeriodFunctions()	Get an RWIterable over an ordered collection of PeriodFunctions.
RELEntryPoint	getRELEntryPointByName(String name)	Get the RELEntryPoint by UniqueName.
RWIterable<RELEntryPoint>	getRELEntryPoints()	Get an RWIterable over an ordered collection of RELEntryPoints.
RWIterable<Script>	getScripts()	Get an RWIterable over an ordered collection of Scripts.
RWIterable<Trigger>	getTriggers()	Get an RWIterable over an ordered collection of Triggers.
Validity	getValidity()	Get the value for Validity.
Set<Variable>	getVariables()	Get the Set of Variables related to Library objects.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<Library> TYPE

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

CUSTOM

static final String CUSTOM

The name of the Custom library that all scripts and libraries depend upon.

See Also:

Constant Field Values

NONE

static final String NONE

The name of the None library that is not editable that all scripts and libraries depend upon by default.

See Also:

Constant Field Values

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

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.

getVariables

Set<Variable> getVariables()

Get the Set of Variables related to Library objects.

Specified by:

getVariables in interface ExecutableSchedulerEntity

Returns:

Set of Variable for Library.

getAlertEscalationActions

RWIterable<AlertEscalationAction> getAlertEscalationActions()

Get an RWIterable over an ordered collection of AlertEscalationActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the AlertEscalationAction depends upon.

Specified by:

getAlertEscalationActions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of AlertEscalationAction objects .

getAlertSourceActions

RWIterable<AlertSourceAction> getAlertSourceActions()

Get an RWIterable over an ordered collection of AlertSourceActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the Alert Action depends upon.

Specified by:

getAlertSourceActions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of AlertSourceAction objects .

getDatabases

RWIterable<Database> getDatabases()

Get an RWIterable over an ordered collection of Databases. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the Database object uses to locate the driver in.

Specified by:

getDatabases in interface LibraryComp

Returns:

An RWIterable over an ordered collection of Database objects .

getEmailAlertGatewayActions

RWIterable<EmailAlertGatewayAction> getEmailAlertGatewayActions()

Get an RWIterable over an ordered collection of EmailAlertGatewayActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the EmailAlertGatewayAction depends upon.

Specified by:

getEmailAlertGatewayActions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of EmailAlertGatewayAction objects .

getExtensionPoints

RWIterable<ExtensionPoint> getExtensionPoints()

Get an RWIterable over an ordered collection of ExtensionPoints. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the ExtensionPoint depends upon.

Specified by:

getExtensionPoints in interface LibraryComp

Returns:

An RWIterable over an ordered collection of ExtensionPoint objects .

getImportActions

RWIterable<ImportAction> getImportActions()

Get an RWIterable over an ordered collection of ImportActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the ImportAction depends upon.

Specified by:

getImportActions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of ImportAction objects .

getJARFiles

RWIterable<JARFile> getJARFiles()

Get an RWIterable over an ordered collection of JARFiles. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The Library the JARFile belongs to.

Specified by:

getJARFiles in interface LibraryComp

Returns:

An RWIterable over an ordered collection of JARFile objects .

createJARFile

JARFile createJARFile()

Create a new JARFile linked to this object.

Returns:

a new JARFile.

getJARFileByName

JARFile getJARFileByName(String name)

Get the JARFile by LibraryName.

Parameters:

name -

Returns:

the JARFile, or null if it could not be found

getJobDefinitionActions

RWIterable<JobDefinitionAction> getJobDefinitionActions()

Get an RWIterable over an ordered collection of JobDefinitionActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the SchedulerEntityAction depends upon.

Specified by:

getJobDefinitionActions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of JobDefinitionAction objects .

getJobDefinitionTypeActions

RWIterable<JobDefinitionTypeAction> getJobDefinitionTypeActions()

Get an RWIterable over an ordered collection of JobDefinitionTypeActions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the JobDefinitionTypeAction depends upon.

Specified by:

getJobDefinitionTypeActions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of JobDefinitionTypeAction objects .

getLibrarySources

RWIterable<LibrarySource> getLibrarySources()

Get an RWIterable over an ordered collection of LibrarySources. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The Library that a LibrarySource belongs to.

Specified by:

getLibrarySources in interface LibraryComp

Returns:

An RWIterable over an ordered collection of LibrarySource objects .

createLibrarySource

LibrarySource createLibrarySource()

Create a new LibrarySource linked to this object.

Returns:

a new LibrarySource.

getLibrarySourceByFQClassName

LibrarySource getLibrarySourceByFQClassName(String fQClassName)

Get the LibrarySource by LibrarySourceFQClassName.

Parameters:

fQClassName -

Returns:

the LibrarySource, or null if it could not be found

getPeriodFunctions

RWIterable<PeriodFunction> getPeriodFunctions()

Get an RWIterable over an ordered collection of PeriodFunctions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the PeriodFunction depends upon.

Specified by:

getPeriodFunctions in interface LibraryComp

Returns:

An RWIterable over an ordered collection of PeriodFunction objects .

getRELEntryPoints

RWIterable<RELEntryPoint> getRELEntryPoints()

Get an RWIterable over an ordered collection of RELEntryPoints. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The Library the RELEntryPoint belongs to

Specified by:

getRELEntryPoints in interface LibraryComp

Returns:

An RWIterable over an ordered collection of RELEntryPoint objects .

createRELEntryPoint

RELEntryPoint createRELEntryPoint()

Create a new RELEntryPoint linked to this object.

Returns:

a new RELEntryPoint.

getRELEntryPointByName

RELEntryPoint getRELEntryPointByName(String name)

Get the RELEntryPoint by UniqueName.

Parameters:

name -

Returns:

the RELEntryPoint, or null if it could not be found

getScripts

RWIterable<Script> getScripts()

Get an RWIterable over an ordered collection of Scripts. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the script depends upon.

Specified by:

getScripts in interface LibraryComp

Returns:

An RWIterable over an ordered collection of Script objects .

getTriggers

RWIterable<Trigger> getTriggers()

Get an RWIterable over an ordered collection of Triggers. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The library that the Trigger depends upon.

Specified by:

getTriggers in interface LibraryComp

Returns:

An RWIterable over an ordered collection of Trigger objects .

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.