Package com.redwood.scheduler.api.model

Interface SAPInfoPackageGroupStep

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface SAPInfoPackageGroupStep
extends NamedDetailObject, BusinessKeyObject, Readable

Step of an InfoPackageGroup.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPInfoPackageGroupStep" 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<SAPInfoPackageGroupStep>	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
String	getLnr()	Get the value for Lnr.
Long	getNum()	Get the value for Num.
String	getObjVersion()	Get the value for ObjVersion.
SAPInfoPackageGroup	getSAPInfoPackageGroup()	Get the SAPInfoPackageGroup.
Long	getWait()	Get the value for Wait.
boolean	isActive()	Get the value for Active.
boolean	isCheckBefore()	Get the value for CheckBefore.
void	setActive(boolean newActive)	Set the value for Active.
void	setCheckBefore(boolean newCheckBefore)	Set the value for CheckBefore.
void	setLnr(String newLnr)	Set the value for Lnr.
void	setNum(Long newNum)	Set the value for Num.
void	setObjVersion(String newObjVersion)	Set the value for ObjVersion.
void	setWait(Long newWait)	Set the value for Wait.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SAPInfoPackageGroupStep> 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

getNum

Long getNum()

Get the value for Num. (Position of the InfoPackage in the group) 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.

getObjVersion

String getObjVersion()

Get the value for ObjVersion. (Object version.)

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.

isCheckBefore

boolean isCheckBefore()

Get the value for CheckBefore. (Check whether request was successful)

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.

getWait

Long getWait()

Get the value for Wait. (Waiting time in minutes until execution of next request) 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.

isActive

boolean isActive()

Get the value for Active. (Indicates whether the InfoPackage should be executed)

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.

getLnr

String getLnr()

Get the value for Lnr. (Quote from SAP's field description: Not More Closely Defined Area, Possibly Used for Patchlevels)

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.

setNum

void setNum(Long newNum)

Set the value for Num. (Position of the InfoPackage in the group) This value is mandatory.

Parameters:

newNum - the new value for Num. 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.

setObjVersion

void setObjVersion(String newObjVersion)

Set the value for ObjVersion. (Object version.) This value is optional.

Parameters:

newObjVersion - the new value for ObjVersion.

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.

setCheckBefore

void setCheckBefore(boolean newCheckBefore)

Set the value for CheckBefore. (Check whether request was successful)

Parameters:

newCheckBefore - the new value for CheckBefore.

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.

setWait

void setWait(Long newWait)

Set the value for Wait. (Waiting time in minutes until execution of next request) This value is mandatory.

Parameters:

newWait - the new value for Wait. 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.

setActive

void setActive(boolean newActive)

Set the value for Active. (Indicates whether the InfoPackage should be executed)

Parameters:

newActive - the new value for Active.

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.

setLnr

void setLnr(String newLnr)

Set the value for Lnr. (Quote from SAP's field description: Not More Closely Defined Area, Possibly Used for Patchlevels) This value is optional.

Parameters:

newLnr - the new value for Lnr.

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.

getSAPInfoPackageGroup

SAPInfoPackageGroup getSAPInfoPackageGroup()

Get the SAPInfoPackageGroup.

Returns:

SAPInfoPackageGroup

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.