Package com.redwood.scheduler.api.model

Interface SAPProcessChain

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPProcessChainComp, SchedulerEntity, SchedulerEntityComp

public interface SAPProcessChain
extends SAPProcessChainComp, NamedDetailObject, BusinessKeyObject, Readable

Process Chain details.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPProcessChain" 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<SAPProcessChain>	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
SAPProcessDefinition	createSAPProcessDefinition()	Create a new SAPProcessDefinition linked to this object.
String	getSAPLanguage()	Get the value for SAPLanguage.
SAPProcessDefinition	getSAPProcessDefinitionByProcessTypeProcessVariant(String processType, String processVariant)	Get the SAPProcessDefinition by TypeInstanceSAPProcessChain.
RWIterable<SAPProcessDefinition>	getSAPProcessDefinitions()	Get an RWIterable over an ordered collection of SAPProcessDefinitions.
SAPSystem	getSAPSystem()	Get the SAPSystem.
void	setSAPLanguage(String newSAPLanguage)	Set the value for SAPLanguage.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedDetailObject

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SAPProcessChain> TYPE

Type that can be used in SchedulerSession.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

getSAPLanguage

String getSAPLanguage()

Get the value for SAPLanguage. (SAP language.) 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.

setSAPLanguage

void setSAPLanguage(String newSAPLanguage)

Set the value for SAPLanguage. (SAP language.) This value is mandatory.

Parameters:

newSAPLanguage - the new value for SAPLanguage. If this is null, then the object cannot be persisted.

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.

getSAPSystem

SAPSystem getSAPSystem()

Get the SAPSystem.

Returns:

SAPSystem

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.

getSAPProcessDefinitions

RWIterable<SAPProcessDefinition> getSAPProcessDefinitions()

Get an RWIterable over an ordered collection of SAPProcessDefinitions. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Process definition.

Specified by:

getSAPProcessDefinitions in interface SAPProcessChainComp

Returns:

An RWIterable over an ordered collection of SAPProcessDefinition objects .

createSAPProcessDefinition

SAPProcessDefinition createSAPProcessDefinition()

Create a new SAPProcessDefinition linked to this object.

Returns:

a new SAPProcessDefinition.

getSAPProcessDefinitionByProcessTypeProcessVariant

SAPProcessDefinition getSAPProcessDefinitionByProcessTypeProcessVariant(String processType,
                                                                        String processVariant)

Get the SAPProcessDefinition by TypeInstanceSAPProcessChain.

Parameters:

processType -

processVariant -

Returns:

the SAPProcessDefinition, or null if it could not be found