Package com.redwood.scheduler.api.model

Interface SAPBatchEvent

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface SAPBatchEvent
extends NamedDetailObject, BusinessKeyObject, Readable

SAP batch event.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPBatchEvent" 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<SAPBatchEvent>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static com.redwood.scheduler.infrastructure.logging.Versions	VERSION_SAPBATCHEVENT

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.NamedDetailObject

VERSION_NAMEDDETAILOBJECT

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, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
DateTimeZone	getLastSAPModificationTime()	Get the value for LastSAPModificationTime.
String	getSAPChangeUser()	Get the value for SAPChangeUser.
SAPSystem	getSAPSystem()	Get the SAPSystem.
boolean	isSystemEvent()	Get the value for SystemEvent.
void	setLastSAPModificationTime(DateTimeZone newLastSAPModificationTime)	Set the value for LastSAPModificationTime.
void	setSAPChangeUser(String newSAPChangeUser)	Set the value for SAPChangeUser.
void	setSystemEvent(boolean newSystemEvent)	Set the value for SystemEvent.

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

VERSION_SAPBATCHEVENT

static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_SAPBATCHEVENT

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "SAPBatchEvent" objects.

See Also:

Constant Field Values

TYPE

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

isSystemEvent

boolean isSystemEvent()

Get the value for SystemEvent. (Event type)

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getSAPChangeUser

String getSAPChangeUser()

Get the value for SAPChangeUser. (User that has created or changed the event)

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getLastSAPModificationTime

DateTimeZone getLastSAPModificationTime()

Get the value for LastSAPModificationTime. (The modification date and time of the batch event.)

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setSystemEvent

void setSystemEvent(boolean newSystemEvent)

Set the value for SystemEvent. (Event type)

Parameters:

newSystemEvent - the new value for SystemEvent.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setSAPChangeUser

void setSAPChangeUser(String newSAPChangeUser)

Set the value for SAPChangeUser. (User that has created or changed the event) This value is optional.

Parameters:

newSAPChangeUser - the new value for SAPChangeUser.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setLastSAPModificationTime

void setLastSAPModificationTime(DateTimeZone newLastSAPModificationTime)

Set the value for LastSAPModificationTime. (The modification date and time of the batch event.) This value is optional.

Parameters:

newLastSAPModificationTime - the new value for LastSAPModificationTime.

Throws:

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:

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.