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 fromSchedulerEntity.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 , deletestatic String
SEC_RANK_CREATE
This rank is made of the following privileges: createstatic String
SEC_RANK_DELETE
This rank is made of the following privileges: create , view , deletestatic String
SEC_RANK_EDIT
This rank is made of the following privileges: create , view , editstatic 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: viewstatic QueryObjectType<Library>
TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.static com.redwood.scheduler.infrastructure.logging.Versions
VERSION_LIBRARY
-
Fields inherited from interface com.redwood.scheduler.api.model.ApplicationObject
VERSION_APPLICATIONOBJECT
-
Fields inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
COPYRIGHT_MESSAGE_BKO, ID_BKO
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.LibraryComp
VERSION_LIBRARYCOMP
-
Fields inherited from interface com.redwood.scheduler.api.model.NamedRootObject
VERSION_NAMEDROOTOBJECT
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.NamedRootObjectComp
VERSION_NAMEDROOTOBJECTCOMP
-
Fields inherited from interface com.redwood.scheduler.api.model.PartitionableObject
VERSION_PARTITIONABLEOBJECT
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.PartitionableObjectComp
VERSION_PARTITIONABLEOBJECTCOMP
-
Fields inherited from interface com.redwood.scheduler.api.model.Readable
COPYRIGHT_MESSAGE_E, ID_E
-
Fields inherited from interface com.redwood.scheduler.api.model.Root
VERSION_ROOT
-
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
-
Fields inherited from interface com.redwood.scheduler.api.model.UniqueNamedApplicationObject
VERSION_UNIQUENAMEDAPPLICATIONOBJECT
-
-
Method Summary
-
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
-
VERSION_LIBRARY
static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_LIBRARY
-
OBJECT_TYPE
static final String OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "Library" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<Library> TYPE
Type that can be used inSchedulerSession.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 benull
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.
-
getVariables
Set<Variable> getVariables()
Get the Set of Variables related to Library objects.- Specified by:
getVariables
in interfaceExecutableSchedulerEntity
- Returns:
- Set of
Variable
for Library.
-
getAlertEscalationActions
RWIterable<AlertEscalationAction> getAlertEscalationActions()
Get anRWIterable
over an ordered collection ofAlertEscalationActions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the AlertEscalationAction depends upon.- Specified by:
getAlertEscalationActions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofAlertEscalationAction
objects .
-
getAlertSourceActions
RWIterable<AlertSourceAction> getAlertSourceActions()
Get anRWIterable
over an ordered collection ofAlertSourceActions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the Alert Action depends upon.- Specified by:
getAlertSourceActions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofAlertSourceAction
objects .
-
getDatabases
RWIterable<Database> getDatabases()
Get anRWIterable
over an ordered collection ofDatabases
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the Database object uses to locate the driver in.- Specified by:
getDatabases
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofDatabase
objects .
-
getEmailAlertGatewayActions
RWIterable<EmailAlertGatewayAction> getEmailAlertGatewayActions()
Get anRWIterable
over an ordered collection ofEmailAlertGatewayActions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the EmailAlertGatewayAction depends upon.- Specified by:
getEmailAlertGatewayActions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofEmailAlertGatewayAction
objects .
-
getExtensionPoints
RWIterable<ExtensionPoint> getExtensionPoints()
Get anRWIterable
over an ordered collection ofExtensionPoints
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the ExtensionPoint depends upon.- Specified by:
getExtensionPoints
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofExtensionPoint
objects .
-
getImportActions
RWIterable<ImportAction> getImportActions()
Get anRWIterable
over an ordered collection ofImportActions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the ImportAction depends upon.- Specified by:
getImportActions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofImportAction
objects .
-
getJARFiles
RWIterable<JARFile> getJARFiles()
Get anRWIterable
over an ordered collection ofJARFiles
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The Library the JARFile belongs to.- Specified by:
getJARFiles
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofJARFile
objects .
-
createJARFile
JARFile createJARFile()
Create a newJARFile
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 anRWIterable
over an ordered collection ofJobDefinitionActions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the SchedulerEntityAction depends upon.- Specified by:
getJobDefinitionActions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofJobDefinitionAction
objects .
-
getJobDefinitionTypeActions
RWIterable<JobDefinitionTypeAction> getJobDefinitionTypeActions()
Get anRWIterable
over an ordered collection ofJobDefinitionTypeActions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the JobDefinitionTypeAction depends upon.- Specified by:
getJobDefinitionTypeActions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofJobDefinitionTypeAction
objects .
-
getLibrarySources
RWIterable<LibrarySource> getLibrarySources()
Get anRWIterable
over an ordered collection ofLibrarySources
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The Library that a LibrarySource belongs to.- Specified by:
getLibrarySources
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofLibrarySource
objects .
-
createLibrarySource
LibrarySource createLibrarySource()
Create a newLibrarySource
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 anRWIterable
over an ordered collection ofPeriodFunctions
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the PeriodFunction depends upon.- Specified by:
getPeriodFunctions
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofPeriodFunction
objects .
-
getRELEntryPoints
RWIterable<RELEntryPoint> getRELEntryPoints()
Get anRWIterable
over an ordered collection ofRELEntryPoints
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The Library the RELEntryPoint belongs to- Specified by:
getRELEntryPoints
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofRELEntryPoint
objects .
-
createRELEntryPoint
RELEntryPoint createRELEntryPoint()
Create a newRELEntryPoint
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 anRWIterable
over an ordered collection ofScripts
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the script depends upon.- Specified by:
getScripts
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofScript
objects .
-
getTriggers
RWIterable<Trigger> getTriggers()
Get anRWIterable
over an ordered collection ofTriggers
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The library that the Trigger depends upon.- Specified by:
getTriggers
in interfaceLibraryComp
- Returns:
- An
RWIterable
over an ordered collection ofTrigger
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.
-
-