Package com.redwood.scheduler.api.model
Interface ImportRuleDefinition
-
- All Superinterfaces:
ApplicationObject,BusinessKeyObject,ImportRuleDefinitionComp,NamedRootObject,NamedRootObjectComp,PartitionableObject,PartitionableObjectComp,Root,SchedulerEntity,SchedulerEntityComp,UniqueNamedApplicationObject
public interface ImportRuleDefinition extends ImportRuleDefinitionComp, UniqueNamedApplicationObject
Implementation for an import match or override. At present we have a hard-coded set of definitions. The definitions are defined by their name, and must be one of the defined constants.
-
-
Field Summary
Fields Modifier and Type Field Description static StringEVENTDEFINITION_NAMEName of definition that matches the name of Event Definition object on Jobs.static StringFILEEVENTDEFINITION_DIRECTORYName of definition that overrides the value of Directory on FileEventDefinitions.static StringFILEEVENTDEFINITION_MOVEDIRECTORYName of definition that overrides the value for MoveDirectory on FileEventDefinitions.static StringFILEEVENTDEFINITION_PATTERNName of definition that overrides the value for Pattern on FileEventDefinitions.static StringFILEEVENTDEFINITION_PROCESSSERVERName of definition that overrides the value for Process Server on FileEventDefinitions.static StringJOB_HOLDONSUBMITName of definition that matches/overrides the value for Hold On Submit on Jobs.static StringJOB_JOBDEFINITIONName of definition that matches the name of JobDefinition object on Jobs.static StringJOB_PARAMETEREXPRESSIONName of definition that matches/overrides expression mapping for a parameter with a given name on Jobs.static StringJOB_QUEUEName of definition that matches/overrides the value for Queue on Jobs.static StringJOBCHAINCALL_HOLDONSUBMITName of definition that matches/overrides the value for Hold On Submit on JobChainCalls.static StringJOBCHAINCALL_JOBDEFINITIONName of definition that matches/overrides the name of JobDefinition objects on JobChainCalls.static StringJOBCHAINCALL_PARAMETEREXPRESSIONName of definition that matches/overrides expression mapping for a parameter with a given name on JobChainCalls.static StringJOBCHAINCALL_PRIORITYName of definition that matches/overrides the value for Priority on JobChainCalls.static StringJOBCHAINCALL_QUEUEName of definition that matches/overrides the value for Queue on JobChainCalls.static StringJOBCHAINCALL_SUBMITDISABLEDName of definition that matches/overrides the value for SubmitDisabled on JobChainCalls.static StringJOBDEFINITIONName of definition that matches JobDefinition objects with a given name.static StringJOBDEFINITION_HOLDONSUBMITName of definition that matches/overrides the value for Hold On Submit on JobDefinitions.static StringJOBDEFINITION_PRIORITYName of definition that matches/overrides the value for Priority on JobDefinitions.static StringJOBDEFINITION_QUEUEName of definition that matches/overrides the value for Queue on JobDefinitions.static StringJOBDEFINITIONPARAMETER_DEFAULTEXPRESSIONName of definition that matches/overrides the default-value expression for JobDefinitionParameter objects.static StringOBJECT_TYPEString that will be returned fromSchedulerEntity.getObjectType()for "ImportRuleDefinition" objects.static StringSCRIPT_RUNASUSERName of definition that matches/overrides JobDefinition objects that are scripts run as.static StringSEC_PRIV_CREATEThis privilege can be granted at a group level.static StringSEC_PRIV_DELETEThis privilege can be granted at a group level.static StringSEC_PRIV_EDITThis privilege can be granted at a group level.static StringSEC_PRIV_VIEWThis privilege can be granted at a group level.static StringSEC_RANK_ALLThis rank is made of the following privileges: create , view , edit , deletestatic StringSEC_RANK_CREATEThis rank is made of the following privileges: createstatic StringSEC_RANK_DELETEThis rank is made of the following privileges: create , view , deletestatic StringSEC_RANK_EDITThis rank is made of the following privileges: create , view , editstatic StringSEC_RANK_NONEThis rank has no privileges assigned to it.static StringSEC_RANK_VIEWThis rank is made of the following privileges: viewstatic QueryObjectType<ImportRuleDefinition>TYPEType that can be used inSchedulerSession.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RequiredPermissioncheckCreatePrivilege()Check whether or not the create action can be performed on this object.RequiredPermissioncheckDeletePrivilege()Check whether or not the delete action can be performed on this object.RequiredPermissioncheckEditPrivilege()Check whether or not the edit action can be performed on this object.RequiredPermissioncheckViewPrivilege()Check whether or not the view action can be performed on this object.ImportMatchRulecreateImportMatchRule(ImportRule newImportRule)Create a newImportMatchRulelinked to this object.ImportOverrideRulecreateImportOverrideRule(ImportRule newImportRule)Create a newImportOverrideRulelinked to this object.RWIterable<ImportMatchRule>getImportMatchRules()Get anRWIterableover an ordered collection ofImportMatchRules.RWIterable<ImportOverrideRule>getImportOverrideRules()Get anRWIterableover an ordered collection ofImportOverrideRules.ObjectDefinitiongetObjectDefinition()Get the ObjectDefinition.booleanisMatcher()Get the value for Matcher.booleanisOverrider()Get the value for Overrider.voidsetObjectDefinition(ObjectDefinition newObjectDefinition)Set the value for ObjectDefinition.-
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 "ImportRuleDefinition" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<ImportRuleDefinition> TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
-
JOBDEFINITION
static final String JOBDEFINITION
Name of definition that matches JobDefinition objects with a given name. This constant gives the name of a predefined ImportRuleDefinition that matches JobDefinition instances. When used to match, the Var1 variable is optional but (if non-null) must match the Name attribute of the JobDefinition case-insensitive.- See Also:
- Constant Field Values
-
JOBDEFINITIONPARAMETER_DEFAULTEXPRESSION
static final String JOBDEFINITIONPARAMETER_DEFAULTEXPRESSION
Name of definition that matches/overrides the default-value expression for JobDefinitionParameter objects. This constant gives the name of a predefined ImportRuleDefinition that matches JobDefinition instances. When used to match, the Var2 variable is optional. Var1 must match the name of a JobDefinitionParameter case-insensitive. If non-null, Var2 must match the value for DefaultExpression of a parameter case-sensitive. (If both are non-null, then the parameter must match both.) When used to override, the Var1 variable gives the name of the parameter (case-insensitive) whose DefaultExpression is replaced by the value of Var2. If Var2 is null, the DefaultExpression will be cleared.- See Also:
- Constant Field Values
-
SCRIPT_RUNASUSER
static final String SCRIPT_RUNASUSER
Name of definition that matches/overrides JobDefinition objects that are scripts run as. This constant gives the name of a predefined ImportRuleDefinition that matches JobDefinition instances that are scripts. When used to match, the Var1 variable is optional. If non-null it must match RunAsUser for the Script case-insensitive. If null, all Scripts match. When used to override, the Var1 variable is used to replace the RunAsUser value for the script.- See Also:
- Constant Field Values
-
JOBCHAINCALL_JOBDEFINITION
static final String JOBCHAINCALL_JOBDEFINITION
Name of definition that matches/overrides the name of JobDefinition objects on JobChainCalls. This constant gives the name of a predefined ImportRuleDefinition that matches JobChainCall instances. When used to match, the Var1 variable is optional but (if non-null) must match the Name attribute of the JobDefinition case-insensitive.- See Also:
- Constant Field Values
-
JOBCHAINCALL_PARAMETEREXPRESSION
static final String JOBCHAINCALL_PARAMETEREXPRESSION
Name of definition that matches/overrides expression mapping for a parameter with a given name on JobChainCalls. This constant gives the name of a predefined ImportRuleDefinition that matches JobChainCall instances. When used to match, the Var2 variable is optional. Var1 must match the name of a JobChainCallParameter case-insensitive. If non-null, Var2 must match the value for expression mapping of a parameter case sensitive. (If both are non-null, then the parameter must match both.) When used to override, the Var1 variable gives the name of the parameter (case insensitive) whose expression mapping is replaced by the value of Var2. If Var2 is null, the expression mapping will be cleared.- See Also:
- Constant Field Values
-
JOBCHAINCALL_HOLDONSUBMIT
static final String JOBCHAINCALL_HOLDONSUBMIT
Name of definition that matches/overrides the value for Hold On Submit on JobChainCalls. This constant gives the name of a predefined ImportRuleDefinition that matches JobChainCall instances. When used to match, Var1 is optional but (if non-null) match the value for Hold On Submit case sensitive. When used to override, the Var1 variable gives the value of that will be set for Hold On Submit. If Var1 is null, Hold On Submit will be cleared.- See Also:
- Constant Field Values
-
JOBCHAINCALL_QUEUE
static final String JOBCHAINCALL_QUEUE
Name of definition that matches/overrides the value for Queue on JobChainCalls. This constant gives the name of a predefined ImportRuleDefinition that matches JobChainCall instances. When used to match, Var1 is optional but (if non-null) match the value for Queue case-sensitive. When used to override, the Var1 variable gives the value of that will be set for Queue. If Var1 is null, Queue will be cleared.- See Also:
- Constant Field Values
-
JOBCHAINCALL_PRIORITY
static final String JOBCHAINCALL_PRIORITY
Name of definition that matches/overrides the value for Priority on JobChainCalls. This constant gives the name of a predefined ImportRuleDefinition that matches JobChainCall instances. When used to match, Var1 is optional but (if non-null) match the value for Priority. When used to override, the Var1 variable gives the value of that will be set for Priority. If Var1 is null, Priority will be cleared.- See Also:
- Constant Field Values
-
JOBCHAINCALL_SUBMITDISABLED
static final String JOBCHAINCALL_SUBMITDISABLED
Name of definition that matches/overrides the value for SubmitDisabled on JobChainCalls. This constant gives the name of a predefined ImportRuleDefinition that matches JobChainCall instances. When used to match, Var1 is optional but (if non-null) match the value for SubmitDisabled. When used to override, the Var1 variable gives the value of that will be set for SubmitDisabled. If Var1 is null, SubmitDisabled will be cleared.- See Also:
- Constant Field Values
-
JOBDEFINITION_HOLDONSUBMIT
static final String JOBDEFINITION_HOLDONSUBMIT
Name of definition that matches/overrides the value for Hold On Submit on JobDefinitions.- See Also:
- Constant Field Values
-
JOBDEFINITION_QUEUE
static final String JOBDEFINITION_QUEUE
Name of definition that matches/overrides the value for Queue on JobDefinitions.- See Also:
- Constant Field Values
-
JOBDEFINITION_PRIORITY
static final String JOBDEFINITION_PRIORITY
Name of definition that matches/overrides the value for Priority on JobDefinitions.- See Also:
- Constant Field Values
-
JOB_JOBDEFINITION
static final String JOB_JOBDEFINITION
Name of definition that matches the name of JobDefinition object on Jobs. This constant gives the name of a predefined ImportRuleDefinition that matches Job instances. When used to match, the Var1 variable is optional but (if non-null) must match the Name attribute of the JobDefinition case-insensitive.- See Also:
- Constant Field Values
-
JOB_PARAMETEREXPRESSION
static final String JOB_PARAMETEREXPRESSION
Name of definition that matches/overrides expression mapping for a parameter with a given name on Jobs. This constant gives the name of a predefined ImportRuleDefinition that matches Job instances. When used to match, the Var2 variable is optional. Var1 must match the name of a JobParameter case-insensitive. If non-null, Var2 must match the value for expression mapping of a parameter case sensitive. (If both are non-null, then the parameter must match both.) When used to override, the Var1 variable gives the name of the parameter (case insensitive) whose expression mapping is replaced by the value of Var2. If Var2 is null, the parameter value will be cleared if the parameter is nullable otherwise an exception will be thrown.- See Also:
- Constant Field Values
-
JOB_QUEUE
static final String JOB_QUEUE
Name of definition that matches/overrides the value for Queue on Jobs. This constant gives the name of a predefined ImportRuleDefinition that matches Job instances. When used to match, Var1 is optional but (if non-null) match the value for Queue case-sensitive. When used to override, the Var1 variable gives the value of that will be set for Queue. If Var1 is null, Queue will be unchanged and an exception will be thrown.- See Also:
- Constant Field Values
-
JOB_HOLDONSUBMIT
static final String JOB_HOLDONSUBMIT
Name of definition that matches/overrides the value for Hold On Submit on Jobs. This constant gives the name of a predefined ImportRuleDefinition that matches Job instances. When used to match, Var1 is optional but (if non-null) match the value for Hold On Submit case sensitive (true or false). When used to override, the Var1 variable gives the value of that will be set for Hold On Submit. If Var1 is null or an unknow boolean value, Hold On Submit will be cleared.- See Also:
- Constant Field Values
-
FILEEVENTDEFINITION_PROCESSSERVER
static final String FILEEVENTDEFINITION_PROCESSSERVER
Name of definition that overrides the value for Process Server on FileEventDefinitions. This constant gives the name of a predefined ImportRuleDefinition that matches FileEventDefinition instances. When used to match, Var1 is optional but (if non-null) match the value for ProcessServer. When used to override, the Var1 variable gives the value of that will be set for ProcessServer. If Var1 is null, ProcessServer will be unchanged and an exception will be thrown.- See Also:
- Constant Field Values
-
EVENTDEFINITION_NAME
static final String EVENTDEFINITION_NAME
Name of definition that matches the name of Event Definition object on Jobs. This constant gives the name of a predefined ImportRuleDefinition that matches EventDefinition instance.- See Also:
- Constant Field Values
-
FILEEVENTDEFINITION_DIRECTORY
static final String FILEEVENTDEFINITION_DIRECTORY
Name of definition that overrides the value of Directory on FileEventDefinitions. This constant gives the name of a predefined ImportRuleDefinition that matches FileEventDefinition instances. When used to match, Var1 is optional but (if non-null) match the value for Directory. When used to override, the Var1 variable gives the value of that will be set for Directory. If Var1 is null, Directory will be unchanged and an exception will be thrown.- See Also:
- Constant Field Values
-
FILEEVENTDEFINITION_PATTERN
static final String FILEEVENTDEFINITION_PATTERN
Name of definition that overrides the value for Pattern on FileEventDefinitions. This constant gives the name of a predefined ImportRuleDefinition that matches FileEventDefinition instances. When used to match, Var1 is optional but (if non-null) match the value for Pattern. When used to override, the Var1 variable gives the value of that will be set for Pattern. If Var1 is null, Pattern will be unchanged and an exception will be thrown.- See Also:
- Constant Field Values
-
FILEEVENTDEFINITION_MOVEDIRECTORY
static final String FILEEVENTDEFINITION_MOVEDIRECTORY
Name of definition that overrides the value for MoveDirectory on FileEventDefinitions. This constant gives the name of a predefined ImportRuleDefinition that matches FileEventDefinition instances. When used to match, Var1 is optional but (if non-null) match the value for MoveDirectory. When used to override, the Var1 variable gives the value of that will be set for MoveDirectory. If Var1 is null, MoveDirectory will be unchanged and an exception will be thrown.- 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
-
isMatcher
boolean isMatcher()
Get the value for Matcher. (Whether this rule definition can do matching 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.
-
isOverrider
boolean isOverrider()
Get the value for Overrider. (Whether this rule definition can do overriding 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.
-
getObjectDefinition
ObjectDefinition getObjectDefinition()
Get the ObjectDefinition.- Returns:
- ObjectDefinition
- 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.
-
setObjectDefinition
void setObjectDefinition(ObjectDefinition newObjectDefinition)
Set the value for ObjectDefinition. This value is mandatory.- Parameters:
newObjectDefinition- is the object to set ObjectDefinition to. If this isnull, then the object cannot be persisted.
-
getImportMatchRules
RWIterable<ImportMatchRule> getImportMatchRules()
Get anRWIterableover an ordered collection ofImportMatchRules. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Definition for a criterion that an ImportRule can use.- Specified by:
getImportMatchRulesin interfaceImportRuleDefinitionComp- Returns:
- An
RWIterableover an ordered collection ofImportMatchRuleobjects .
-
createImportMatchRule
ImportMatchRule createImportMatchRule(ImportRule newImportRule)
Create a newImportMatchRulelinked to this object.- Parameters:
newImportRule- The other parent of theImportMatchRuleImportRuleassociation.- Returns:
- a new
ImportMatchRule.
-
getImportOverrideRules
RWIterable<ImportOverrideRule> getImportOverrideRules()
Get anRWIterableover an ordered collection ofImportOverrideRules. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Definition for an override to apply to objects that match an ImportRule.- Specified by:
getImportOverrideRulesin interfaceImportRuleDefinitionComp- Returns:
- An
RWIterableover an ordered collection ofImportOverrideRuleobjects .
-
createImportOverrideRule
ImportOverrideRule createImportOverrideRule(ImportRule newImportRule)
Create a newImportOverrideRulelinked to this object.- Parameters:
newImportRule- The other parent of theImportOverrideRuleImportRuleassociation.- Returns:
- a new
ImportOverrideRule.
-
checkCreatePrivilege
RequiredPermission checkCreatePrivilege()
Check whether or not the create action can be performed on this object.- Returns:
- a
RequiredPermissioninstance 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
RequiredPermissioninstance 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
RequiredPermissioninstance 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
RequiredPermissioninstance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
-
-