Package com.redwood.scheduler.api.model
Interface SAPProcessDefinition
-
- All Superinterfaces:
BusinessKeyObject
,Detail
,Readable
,SAPProcessDefinitionComp
,SchedulerEntity
,SchedulerEntityComp
public interface SAPProcessDefinition extends SAPProcessDefinitionComp, Detail, BusinessKeyObject, Readable
Process definition.
-
-
Field Summary
Fields Modifier and Type Field Description static String
OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "SAPProcessDefinition" objects.static String
SEC_RANK_ALL
This rank is made of the following privileges:static String
SEC_RANK_NONE
This rank has no privileges assigned to it.static QueryObjectType<SAPProcessDefinition>
TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.static com.redwood.scheduler.infrastructure.logging.Versions
VERSION_SAPPROCESSDEFINITION
-
Fields inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
COPYRIGHT_MESSAGE_BKO, ID_BKO
-
Fields inherited from interface com.redwood.scheduler.api.model.Detail
VERSION_DETAIL
-
Fields inherited from interface com.redwood.scheduler.api.model.Readable
COPYRIGHT_MESSAGE_E, ID_E
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SAPProcessDefinitionComp
VERSION_SAPPROCESSDEFINITIONCOMP
-
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SAPProcessRestart
createSAPProcessRestart()
Create a newSAPProcessRestart
linked to this object.String
getDeprecated1()
Get the value for Deprecated1.Long
getDeprecated2()
Get the value for Deprecated2.String
getEventEnd()
Get the value for EventEnd.String
getEventEndParameter()
Get the value for EventEndParameter.String
getEventGreen()
Get the value for EventGreen.String
getEventGreenParameter()
Get the value for EventGreenParameter.String
getEventRed()
Get the value for EventRed.String
getEventRedParameter()
Get the value for EventRedParameter.String
getEventStart()
Get the value for EventStart.String
getEventStartParameter()
Get the value for EventStartParameter.Long
getMaxNumberOfRestarts()
Get the value for MaxNumberOfRestarts.String
getOnErrorProcessType()
Get the value for OnErrorProcessType.String
getOnErrorProcessVariant()
Get the value for OnErrorProcessVariant.String
getProcessType()
Get the value for ProcessType.String
getProcessTypeDescription()
Get the value for ProcessTypeDescription.String
getProcessVariant()
Get the value for ProcessVariant.String
getProcessVariantDescription()
Get the value for ProcessVariantDescription.Long
getRestartDelay()
Get the value for RestartDelay.TimeUnit
getRestartDelayUnits()
Get the value for RestartDelayUnits.SAPProcessChain
getSAPProcessChain()
Get the SAPProcessChain.SAPProcessRestart
getSAPProcessRestartByJob(Job job)
Get the SAPProcessRestart by JobSAPProcessDefinition.RWIterable<SAPProcessRestart>
getSAPProcessRestarts()
Get anRWIterable
over an ordered collection ofSAPProcessRestarts
.boolean
isGreenEqualsRed()
Get the value for GreenEqualsRed.boolean
isRestartUnchecked()
Get the value for RestartUnchecked.void
setDeprecated1(String newDeprecated1)
Set the value for Deprecated1.void
setDeprecated2(Long newDeprecated2)
Set the value for Deprecated2.void
setEventEnd(String newEventEnd)
Set the value for EventEnd.void
setEventEndParameter(String newEventEndParameter)
Set the value for EventEndParameter.void
setEventGreen(String newEventGreen)
Set the value for EventGreen.void
setEventGreenParameter(String newEventGreenParameter)
Set the value for EventGreenParameter.void
setEventRed(String newEventRed)
Set the value for EventRed.void
setEventRedParameter(String newEventRedParameter)
Set the value for EventRedParameter.void
setEventStart(String newEventStart)
Set the value for EventStart.void
setEventStartParameter(String newEventStartParameter)
Set the value for EventStartParameter.void
setGreenEqualsRed(boolean newGreenEqualsRed)
Set the value for GreenEqualsRed.void
setMaxNumberOfRestarts(Long newMaxNumberOfRestarts)
Set the value for MaxNumberOfRestarts.void
setOnErrorProcessType(String newOnErrorProcessType)
Set the value for OnErrorProcessType.void
setOnErrorProcessVariant(String newOnErrorProcessVariant)
Set the value for OnErrorProcessVariant.void
setProcessType(String newProcessType)
Set the value for ProcessType.void
setProcessTypeDescription(String newProcessTypeDescription)
Set the value for ProcessTypeDescription.void
setProcessVariant(String newProcessVariant)
Set the value for ProcessVariant.void
setProcessVariantDescription(String newProcessVariantDescription)
Set the value for ProcessVariantDescription.void
setRestartDelay(Long newRestartDelay)
Set the value for RestartDelay.void
setRestartDelayUnits(TimeUnit newRestartDelayUnits)
Set the value for RestartDelayUnits.void
setRestartUnchecked(boolean newRestartUnchecked)
Set the value for RestartUnchecked.-
Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
getBusinessKey
-
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_SAPPROCESSDEFINITION
static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_SAPPROCESSDEFINITION
-
OBJECT_TYPE
static final String OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "SAPProcessDefinition" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<SAPProcessDefinition> TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.
-
SEC_RANK_NONE
static final String SEC_RANK_NONE
This rank has no privileges assigned to it.- See Also:
- Constant Field Values
-
SEC_RANK_ALL
static final String SEC_RANK_ALL
This rank is made of the following privileges:- See Also:
- Constant Field Values
-
-
Method Detail
-
getEventStart
String getEventStart()
Get the value for EventStart. (Start event.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventStartParameter
String getEventStartParameter()
Get the value for EventStartParameter. (Start event parameter.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getProcessType
String getProcessType()
Get the value for ProcessType. (Process type.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getProcessTypeDescription
String getProcessTypeDescription()
Get the value for ProcessTypeDescription. (Optional process type description)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getProcessVariant
String getProcessVariant()
Get the value for ProcessVariant. (Process variant.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getProcessVariantDescription
String getProcessVariantDescription()
Get the value for ProcessVariantDescription. (Optional process variant description)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getDeprecated1
String getDeprecated1()
Get the value for Deprecated1. (Process instance.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventEnd
String getEventEnd()
Get the value for EventEnd. (End event.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventEndParameter
String getEventEndParameter()
Get the value for EventEndParameter. (End event parameter.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventGreen
String getEventGreen()
Get the value for EventGreen. (Green event.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventGreenParameter
String getEventGreenParameter()
Get the value for EventGreenParameter. (Green event parameter.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventRed
String getEventRed()
Get the value for EventRed. (Red event.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getEventRedParameter
String getEventRedParameter()
Get the value for EventRedParameter. (Red event parameter.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
isGreenEqualsRed
boolean isGreenEqualsRed()
Get the value for GreenEqualsRed. (Whether green event equals red.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getOnErrorProcessType
String getOnErrorProcessType()
Get the value for OnErrorProcessType. (Process type to call on error.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getOnErrorProcessVariant
String getOnErrorProcessVariant()
Get the value for OnErrorProcessVariant. (Process variant to call on error.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getMaxNumberOfRestarts
Long getMaxNumberOfRestarts()
Get the value for MaxNumberOfRestarts. (Max number of restarts.) 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.
-
getDeprecated2
Long getDeprecated2()
Get the value for Deprecated2. (This attribute is deprecated and no longer in use.) 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.
-
getRestartDelay
Long getRestartDelay()
Get the value for RestartDelay. (Delay between restarts.) 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.
-
getRestartDelayUnits
TimeUnit getRestartDelayUnits()
Get the value for RestartDelayUnits. (Time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) 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.
-
isRestartUnchecked
boolean isRestartUnchecked()
Get the value for RestartUnchecked. (Ignore SAP Restart Settings. Your process chain can be repeatable or repairable in SAP; this attribute allows you to ignore the setting in SAP.)- Returns:
- the field
- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventStart
void setEventStart(String newEventStart)
Set the value for EventStart. (Start event.) This value is optional.- Parameters:
newEventStart
- the new value for EventStart.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventStartParameter
void setEventStartParameter(String newEventStartParameter)
Set the value for EventStartParameter. (Start event parameter.) This value is optional.- Parameters:
newEventStartParameter
- the new value for EventStartParameter.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setProcessType
void setProcessType(String newProcessType)
Set the value for ProcessType. (Process type.) This value is optional.- Parameters:
newProcessType
- the new value for ProcessType.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setProcessTypeDescription
void setProcessTypeDescription(String newProcessTypeDescription)
Set the value for ProcessTypeDescription. (Optional process type description) This value is optional.- Parameters:
newProcessTypeDescription
- the new value for ProcessTypeDescription.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setProcessVariant
void setProcessVariant(String newProcessVariant)
Set the value for ProcessVariant. (Process variant.) This value is optional.- Parameters:
newProcessVariant
- the new value for ProcessVariant.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setProcessVariantDescription
void setProcessVariantDescription(String newProcessVariantDescription)
Set the value for ProcessVariantDescription. (Optional process variant description) This value is optional.- Parameters:
newProcessVariantDescription
- the new value for ProcessVariantDescription.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setDeprecated1
void setDeprecated1(String newDeprecated1)
Set the value for Deprecated1. (Process instance.) This value is optional.- Parameters:
newDeprecated1
- the new value for Deprecated1.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventEnd
void setEventEnd(String newEventEnd)
Set the value for EventEnd. (End event.) This value is optional.- Parameters:
newEventEnd
- the new value for EventEnd.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventEndParameter
void setEventEndParameter(String newEventEndParameter)
Set the value for EventEndParameter. (End event parameter.) This value is optional.- Parameters:
newEventEndParameter
- the new value for EventEndParameter.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventGreen
void setEventGreen(String newEventGreen)
Set the value for EventGreen. (Green event.) This value is optional.- Parameters:
newEventGreen
- the new value for EventGreen.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventGreenParameter
void setEventGreenParameter(String newEventGreenParameter)
Set the value for EventGreenParameter. (Green event parameter.) This value is optional.- Parameters:
newEventGreenParameter
- the new value for EventGreenParameter.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventRed
void setEventRed(String newEventRed)
Set the value for EventRed. (Red event.) This value is optional.- Parameters:
newEventRed
- the new value for EventRed.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setEventRedParameter
void setEventRedParameter(String newEventRedParameter)
Set the value for EventRedParameter. (Red event parameter.) This value is optional.- Parameters:
newEventRedParameter
- the new value for EventRedParameter.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setGreenEqualsRed
void setGreenEqualsRed(boolean newGreenEqualsRed)
Set the value for GreenEqualsRed. (Whether green event equals red.)- Parameters:
newGreenEqualsRed
- the new value for GreenEqualsRed.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setOnErrorProcessType
void setOnErrorProcessType(String newOnErrorProcessType)
Set the value for OnErrorProcessType. (Process type to call on error.) This value is optional.- Parameters:
newOnErrorProcessType
- the new value for OnErrorProcessType.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setOnErrorProcessVariant
void setOnErrorProcessVariant(String newOnErrorProcessVariant)
Set the value for OnErrorProcessVariant. (Process variant to call on error.) This value is optional.- Parameters:
newOnErrorProcessVariant
- the new value for OnErrorProcessVariant.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
setMaxNumberOfRestarts
void setMaxNumberOfRestarts(Long newMaxNumberOfRestarts)
Set the value for MaxNumberOfRestarts. (Max number of restarts.) This value is mandatory.- Parameters:
newMaxNumberOfRestarts
- the new value for MaxNumberOfRestarts. 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.
-
setDeprecated2
void setDeprecated2(Long newDeprecated2)
Set the value for Deprecated2. (This attribute is deprecated and no longer in use.) This value is mandatory.- Parameters:
newDeprecated2
- the new value for Deprecated2. 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.
-
setRestartDelay
void setRestartDelay(Long newRestartDelay)
Set the value for RestartDelay. (Delay between restarts.) This value is mandatory.- Parameters:
newRestartDelay
- the new value for RestartDelay. 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.
-
setRestartDelayUnits
void setRestartDelayUnits(TimeUnit newRestartDelayUnits)
Set the value for RestartDelayUnits. (Time units for 'restart delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory.- Parameters:
newRestartDelayUnits
- the new value for RestartDelayUnits. 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.
-
setRestartUnchecked
void setRestartUnchecked(boolean newRestartUnchecked)
Set the value for RestartUnchecked. (Ignore SAP Restart Settings. Your process chain can be repeatable or repairable in SAP; this attribute allows you to ignore the setting in SAP.)- Parameters:
newRestartUnchecked
- the new value for RestartUnchecked.- Throws:
ObjectNotAttachedToSessionException
- This will be thrown if this method is called while the object is not attached to a session.
-
getSAPProcessChain
SAPProcessChain getSAPProcessChain()
Get the SAPProcessChain.- Returns:
- SAPProcessChain
- 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.
-
getSAPProcessRestarts
RWIterable<SAPProcessRestart> getSAPProcessRestarts()
Get anRWIterable
over an ordered collection ofSAPProcessRestarts
. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. Process restart.- Specified by:
getSAPProcessRestarts
in interfaceSAPProcessDefinitionComp
- Returns:
- An
RWIterable
over an ordered collection ofSAPProcessRestart
objects .
-
createSAPProcessRestart
SAPProcessRestart createSAPProcessRestart()
Create a newSAPProcessRestart
linked to this object.- Returns:
- a new
SAPProcessRestart
.
-
getSAPProcessRestartByJob
SAPProcessRestart getSAPProcessRestartByJob(Job job)
Get the SAPProcessRestart by JobSAPProcessDefinition.- Parameters:
job
-- Returns:
- the SAPProcessRestart, or
null
if it could not be found
-
-