Package com.redwood.scheduler.api.model
Interface JobDefinitionType
-
- All Superinterfaces:
ApplicationObject
,BusinessKeyObject
,JobDefinitionTypeComp
,NamedRootObject
,NamedRootObjectComp
,PartitionableObject
,PartitionableObjectComp
,Readable
,Root
,SchedulerEntity
,SchedulerEntityComp
,UniqueNamedApplicationObject
public interface JobDefinitionType extends JobDefinitionTypeComp, UniqueNamedApplicationObject, Readable
The type of a job definition. The type of a job definition controls how it is run.
-
-
Field Summary
Fields Modifier and Type Field Description static String
AS400
The name of the AS400 JobDefinitionType.static String
BASH
The name of the BASH JobDefinitionType.static String
CMD
The name of the Microsoft Windows CMD JobDefinitionType.static String
CSH
The name of the CSH JobDefinitionType.static String
DCL
The name of the DCL JobDefinitionType.static String
FTP
The name of the FTP JobDefinitionType.static String
GROOVY
The name of the Groovy JobDefinitionType.static String
HTTP
The name of the HTTP JobDefinitionTypestatic String
HTTPRaw
The name of the HTTP (Raw) JobDefinitionType.static String
JAVA
The name of the remote JAVA JobDefinitionType.static String
JCL_FTP
The name of the JobDefinitionType to run JCL jobs via FTP.static String
JDBC
The name of the JDBC JobDefinitionType.static String
JOB_CHAIN
The name of the JobChain JobDefinitionType.static String
JXBP
The name of the JXBP JobDefinitionType.static String
KSH
The name of the KSH JobDefinitionType.static String
MAIL
The name of the Mail JobDefinitionType.static String
OBJECT_SEARCH
The name of the ObjectSearch JobDefinitionType.static String
OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "JobDefinitionType" objects.static String
OraApps
The name of the Oracle Applications JobDefinitionType.static String
OracleJob
The name of the OracleJob JobDefinitionType.static String
OraOhi
The name of the Oracle Health Insurance JobDefinitionType.static String
OS_NATIVE
The name of the OS Native JobDefinitionType.static String
PeopleSoft
The name of the PeopleSoft JobDefinitionType.static String
PERL
The name of the PERL JobDefinitionType.static String
PERLUNICODE
The name of the PERL JobDefinitionType with Unicode parameters.static String
PS1
The name of the Microsoft PowerShell JobDefinitionType.static String
PUBLISH
The name of the Publish JobDefinitionType.static String
PYTHON
The name of the PYTHON JobDefinitionType.static String
R
The name of the 'R project' statistical language JobDefinitionType.static String
RECONCILIATION
The name of the Reconciliation JobDefinitionType.static String
REDWOOD_SCRIPT
The name of the System JobDefinitionType.static String
REPORT
The name of the Report JobDefinitionType.static String
SAP_BOBJ
The name of the SAP Business Objects JobDefinitionType.static String
SAP_PI
The name of the SAP XI/PI JobDefinitionType.static String
SAP_R3
The name of the SAP R/3 JobDefinitionType.static String
SEC_PRIV_CANMODIFYJOBSOFTYPE
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: view , canModifyJobsOfTypestatic String
SEC_RANK_CANMODIFYJOBSOFTYPE
This rank is made of the following privileges: view , canModifyJobsOfTypestatic 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 String
SOAP
The name of the SOAP JobDefinitionType.static String
SQLPLUS
The name of the SQL*Plus JobDefinitionType.static String
SYSTEM
The name of the System JobDefinitionType.static QueryObjectType<JobDefinitionType>
TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.static String
USERMESSAGE
The name of the User Message JobDefinitionType.static String
VB_SCRIPT
The name of the Microsoft Windows VBScript JobDefinitionType.-
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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description boolean
canCreateJobDefinitionOfType()
Check to see if a user can create a JobDefinition for this type (includes checking RMJ privileges).RequiredPermission
checkCanModifyJobsOfTypePrivilege()
Check whether or not the canModifyJobsOfType action can be performed on this object.void
checkLicense()
Check to see if the job definition type is licensed, and can be used to create job definitions or run jobs of this job definition type.RequiredPermission
checkViewPrivilege()
Check whether or not the view action can be performed on this object.JobDefinitionTypeAction
createJobDefinitionTypeAction()
Create a newJobDefinitionTypeAction
linked to this object.ProcessServerJobDefinitionType
createProcessServerJobDefinitionType(ProcessServer newProcessServer)
Create a newProcessServerJobDefinitionType
linked to this object.ArrayParameterSupport
getArrayParameterSupport()
Get the value for ArrayParameterSupport.Service
getHandlerService()
Get the HandlerService.JobDefinitionTypeAction
getJobDefinitionTypeActionByType(JobDefinitionTypeActionType type)
Get the JobDefinitionTypeAction by JobDefinitionTypeActionType.RWIterable<JobDefinitionTypeAction>
getJobDefinitionTypeActions()
Get anRWIterable
over an ordered collection ofJobDefinitionTypeActions
.Library
getLibrary()
Get the Library.ProcessServerJobDefinitionType
getProcessServerJobDefinitionTypeByProcessServer(ProcessServer processServer)
Get the ProcessServerJobDefinitionType by Association.RWIterable<ProcessServerJobDefinitionType>
getProcessServerJobDefinitionTypes()
Get anRWIterable
over an ordered collection ofProcessServerJobDefinitionTypes
.Set<CompletionStrategyType>
getSupportedCompletionStrategies()
Get theCompletionStrategyType
s supported by this JobDefinitionType.String
getSupportedCompletionStrategyCodes()
Get the value for SupportedCompletionStrategyCodes.Validity
getValidity()
Get the value for Validity.boolean
isCompletionStrategySupported()
Deprecated.boolean
isCustom()
Returns true if this JobDefinitionType represents a custom type.void
setArrayParameterSupport(ArrayParameterSupport newArrayParameterSupport)
Set the value for ArrayParameterSupport.void
setHandlerService(Service newHandlerService)
Set the value for HandlerService.void
setLibrary(Library newLibrary)
Set the value for Library.void
setSupportedCompletionStrategies(Set<CompletionStrategyType> completionStrategies)
Set theCompletionStrategyType
s supported by this JobDefinitionType.void
setSupportedCompletionStrategyCodes(String newSupportedCompletionStrategyCodes)
Set the value for SupportedCompletionStrategyCodes.-
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 fromSchedulerEntity.getObjectType()
for "JobDefinitionType" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<JobDefinitionType> TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.
-
CMD
static final String CMD
The name of the Microsoft Windows CMD JobDefinitionType.- See Also:
- Constant Field Values
-
KSH
static final String KSH
The name of the KSH JobDefinitionType.- See Also:
- Constant Field Values
-
BASH
static final String BASH
The name of the BASH JobDefinitionType.- See Also:
- Constant Field Values
-
CSH
static final String CSH
The name of the CSH JobDefinitionType.- See Also:
- Constant Field Values
-
VB_SCRIPT
static final String VB_SCRIPT
The name of the Microsoft Windows VBScript JobDefinitionType.- See Also:
- Constant Field Values
-
PS1
static final String PS1
The name of the Microsoft PowerShell JobDefinitionType.- See Also:
- Constant Field Values
-
REDWOOD_SCRIPT
static final String REDWOOD_SCRIPT
The name of the System JobDefinitionType.- See Also:
- Constant Field Values
-
AS400
static final String AS400
The name of the AS400 JobDefinitionType.- See Also:
- Constant Field Values
-
JOB_CHAIN
static final String JOB_CHAIN
The name of the JobChain JobDefinitionType.- See Also:
- Constant Field Values
-
SAP_R3
static final String SAP_R3
The name of the SAP R/3 JobDefinitionType.- See Also:
- Constant Field Values
-
SAP_PI
static final String SAP_PI
The name of the SAP XI/PI JobDefinitionType.- See Also:
- Constant Field Values
-
SAP_BOBJ
static final String SAP_BOBJ
The name of the SAP Business Objects JobDefinitionType.- See Also:
- Constant Field Values
-
SYSTEM
static final String SYSTEM
The name of the System JobDefinitionType.- See Also:
- Constant Field Values
-
JCL_FTP
static final String JCL_FTP
The name of the JobDefinitionType to run JCL jobs via FTP.- See Also:
- Constant Field Values
-
OS_NATIVE
static final String OS_NATIVE
The name of the OS Native JobDefinitionType.- See Also:
- Constant Field Values
-
PERL
static final String PERL
The name of the PERL JobDefinitionType.- See Also:
- Constant Field Values
-
PERLUNICODE
static final String PERLUNICODE
The name of the PERL JobDefinitionType with Unicode parameters.- See Also:
- Constant Field Values
-
PYTHON
static final String PYTHON
The name of the PYTHON JobDefinitionType.- See Also:
- Constant Field Values
-
DCL
static final String DCL
The name of the DCL JobDefinitionType.- See Also:
- Constant Field Values
-
JXBP
static final String JXBP
The name of the JXBP JobDefinitionType.- See Also:
- Constant Field Values
-
MAIL
static final String MAIL
The name of the Mail JobDefinitionType.- See Also:
- Constant Field Values
-
FTP
static final String FTP
The name of the FTP JobDefinitionType.- See Also:
- Constant Field Values
-
SQLPLUS
static final String SQLPLUS
The name of the SQL*Plus JobDefinitionType.- See Also:
- Constant Field Values
-
GROOVY
static final String GROOVY
The name of the Groovy JobDefinitionType.- See Also:
- Constant Field Values
-
HTTP
static final String HTTP
The name of the HTTP JobDefinitionType- See Also:
- Constant Field Values
-
SOAP
static final String SOAP
The name of the SOAP JobDefinitionType.- See Also:
- Constant Field Values
-
HTTPRaw
static final String HTTPRaw
The name of the HTTP (Raw) JobDefinitionType.- See Also:
- Constant Field Values
-
JDBC
static final String JDBC
The name of the JDBC JobDefinitionType.- See Also:
- Constant Field Values
-
OracleJob
static final String OracleJob
The name of the OracleJob JobDefinitionType.- See Also:
- Constant Field Values
-
REPORT
static final String REPORT
The name of the Report JobDefinitionType.- See Also:
- Constant Field Values
-
OraApps
static final String OraApps
The name of the Oracle Applications JobDefinitionType.- See Also:
- Constant Field Values
-
OraOhi
static final String OraOhi
The name of the Oracle Health Insurance JobDefinitionType.- See Also:
- Constant Field Values
-
PeopleSoft
static final String PeopleSoft
The name of the PeopleSoft JobDefinitionType.- See Also:
- Constant Field Values
-
USERMESSAGE
static final String USERMESSAGE
The name of the User Message JobDefinitionType.- See Also:
- Constant Field Values
-
PUBLISH
static final String PUBLISH
The name of the Publish JobDefinitionType.- See Also:
- Constant Field Values
-
OBJECT_SEARCH
static final String OBJECT_SEARCH
The name of the ObjectSearch JobDefinitionType.- See Also:
- Constant Field Values
-
RECONCILIATION
static final String RECONCILIATION
The name of the Reconciliation JobDefinitionType.- See Also:
- Constant Field Values
-
R
static final String R
The name of the 'R project' statistical language JobDefinitionType.- See Also:
- Constant Field Values
-
JAVA
static final String JAVA
The name of the remote JAVA JobDefinitionType.- 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_CANMODIFYJOBSOFTYPE
static final String SEC_PRIV_CANMODIFYJOBSOFTYPE
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_VIEW
static final String SEC_RANK_VIEW
This rank is made of the following privileges: view- See Also:
- Constant Field Values
-
SEC_RANK_CANMODIFYJOBSOFTYPE
static final String SEC_RANK_CANMODIFYJOBSOFTYPE
This rank is made of the following privileges: view , canModifyJobsOfType- See Also:
- Constant Field Values
-
SEC_RANK_ALL
static final String SEC_RANK_ALL
This rank is made of the following privileges: view , canModifyJobsOfType- See Also:
- Constant Field Values
-
-
Method Detail
-
getArrayParameterSupport
ArrayParameterSupport getArrayParameterSupport()
Get the value for ArrayParameterSupport. (Indicates the support of array parameters for this JDT.) 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.
-
getSupportedCompletionStrategyCodes
String getSupportedCompletionStrategyCodes()
Get the value for SupportedCompletionStrategyCodes. ( String of codes for theCompletionStrategyType
s that are supported by this JobDefinitionType. (other thanDefault
which is always supported) Internal, usegetSupportedCompletionStrategies()
to get an set of proper enum values for this. )- Returns:
- the field
- Throws:
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 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.
-
setArrayParameterSupport
void setArrayParameterSupport(ArrayParameterSupport newArrayParameterSupport)
Set the value for ArrayParameterSupport. (Indicates the support of array parameters for this JDT.) This value is mandatory.- Parameters:
newArrayParameterSupport
- the new value for ArrayParameterSupport. If this isnull
, 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.
-
setSupportedCompletionStrategyCodes
void setSupportedCompletionStrategyCodes(String newSupportedCompletionStrategyCodes)
Set the value for SupportedCompletionStrategyCodes. ( String of codes for theCompletionStrategyType
s that are supported by this JobDefinitionType. (other thanDefault
which is always supported) Internal, usegetSupportedCompletionStrategies()
to get an set of proper enum values for this. ) This value is optional.- Parameters:
newSupportedCompletionStrategyCodes
- the new value for SupportedCompletionStrategyCodes.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
isCompletionStrategySupported
@Deprecated boolean isCompletionStrategySupported()
Deprecated.This operation is deprecated, use isCompletionStrategySupported(CompletionStrategyType) instead.Deprecated, use
getSupportedCompletionStrategies()
instead. Indicates whether this JobDefinitionType supports a completion strategy other thanDefault
.- Returns:
- Returns true if this JobDefinitionType supports a completion strategy other than Default, false otherwise.
-
getSupportedCompletionStrategies
Set<CompletionStrategyType> getSupportedCompletionStrategies()
Get theCompletionStrategyType
s supported by this JobDefinitionType.- Returns:
- A set containing the
CompletionStrategyType
s supported by this JobDefinitionType.
-
setSupportedCompletionStrategies
void setSupportedCompletionStrategies(Set<CompletionStrategyType> completionStrategies)
Set theCompletionStrategyType
s supported by this JobDefinitionType.- Parameters:
completionStrategies
- A set containing theCompletionStrategyType
s to be supported by this JobDefinitionType.
-
checkLicense
void checkLicense() throws LicenseException
Check to see if the job definition type is licensed, and can be used to create job definitions or run jobs of this job definition type.- Throws:
LicenseException
- License violation.
-
canCreateJobDefinitionOfType
boolean canCreateJobDefinitionOfType()
Check to see if a user can create a JobDefinition for this type (includes checking RMJ privileges).- Returns:
- Returns true if the user can create this JobDefinition for this type, false otherwise.
-
isCustom
boolean isCustom()
Returns true if this JobDefinitionType represents a custom type. Custom types start with Redwood_ or Robo_ and are application signed 'locked'.- Returns:
- Returns true if this JobDefinitionType represents a custom type. Custom types start with Redwood_ or Robo_ and are application signed 'locked'.
-
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.
-
getHandlerService
Service getHandlerService()
Get the HandlerService.- Returns:
- HandlerService
- 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 optional.- Parameters:
newLibrary
- is the object to set Library to. The library associated with this JobDefinitionType.
-
setHandlerService
void setHandlerService(Service newHandlerService)
Set the value for HandlerService. This value is mandatory.- Parameters:
newHandlerService
- is the object to set HandlerService to. The job definition types provided by this service. If this isnull
, then the object cannot be persisted.
-
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
. Actions defined for this JobDefinitionType.- Specified by:
getJobDefinitionTypeActions
in interfaceJobDefinitionTypeComp
- Returns:
- An
RWIterable
over an ordered collection ofJobDefinitionTypeAction
objects .
-
createJobDefinitionTypeAction
JobDefinitionTypeAction createJobDefinitionTypeAction()
Create a newJobDefinitionTypeAction
linked to this object.- Returns:
- a new
JobDefinitionTypeAction
.
-
getJobDefinitionTypeActionByType
JobDefinitionTypeAction getJobDefinitionTypeActionByType(JobDefinitionTypeActionType type)
Get the JobDefinitionTypeAction by JobDefinitionTypeActionType.- Parameters:
type
-- Returns:
- the JobDefinitionTypeAction, or
null
if it could not be found
-
getProcessServerJobDefinitionTypes
RWIterable<ProcessServerJobDefinitionType> getProcessServerJobDefinitionTypes()
Get anRWIterable
over an ordered collection ofProcessServerJobDefinitionTypes
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. The job definition types this process server will run.- Specified by:
getProcessServerJobDefinitionTypes
in interfaceJobDefinitionTypeComp
- Returns:
- An
RWIterable
over an ordered collection ofProcessServerJobDefinitionType
objects .
-
createProcessServerJobDefinitionType
ProcessServerJobDefinitionType createProcessServerJobDefinitionType(ProcessServer newProcessServer)
Create a newProcessServerJobDefinitionType
linked to this object.- Parameters:
newProcessServer
- The other parent of theProcessServerJobDefinitionTypeProcessServer
association.- Returns:
- a new
ProcessServerJobDefinitionType
.
-
getProcessServerJobDefinitionTypeByProcessServer
ProcessServerJobDefinitionType getProcessServerJobDefinitionTypeByProcessServer(ProcessServer processServer)
Get the ProcessServerJobDefinitionType by Association.- Parameters:
processServer
-- Returns:
- the ProcessServerJobDefinitionType, or
null
if it could not be found
-
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.
-
checkCanModifyJobsOfTypePrivilege
RequiredPermission checkCanModifyJobsOfTypePrivilege()
Check whether or not the canModifyJobsOfType 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.
-
-