Package com.redwood.scheduler.api.model

Interface SAPXBPEventRule

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface SAPXBPEventRule
extends Detail, Readable

XBP event synchronization settings.

Field Summary

Fields

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

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

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the value for Description.
EventDefinition	getEventDefinition()	Get the EventDefinition.
String	getSAPEventId()	Get the value for SAPEventId.
String	getSAPEventParameter()	Get the value for SAPEventParameter.
SAPSystem	getSAPSystem()	Get the SAPSystem.
boolean	isEnabled()	Get the value for Enabled.
void	setDescription(String newDescription)	Set the value for Description.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setEventDefinition(EventDefinition newEventDefinition)	Set the value for EventDefinition.
void	setSAPEventId(String newSAPEventId)	Set the value for SAPEventId.
void	setSAPEventParameter(String newSAPEventParameter)	Set the value for SAPEventParameter.

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

See Also:

Constant Field Values

TYPE

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

getDescription

String getDescription()

Get the value for Description. (The description of this step)

Returns:

the field

Throws:

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

getSAPEventId

String getSAPEventId()

Get the value for SAPEventId. (SAP event id mask.) This value is mandatory, and therefore will not be null 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.

getSAPEventParameter

String getSAPEventParameter()

Get the value for SAPEventParameter. (SAP event parameter mask.) This value is mandatory, and therefore will not be null 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.

isEnabled

boolean isEnabled()

Get the value for Enabled. (Whether this rule is currently enabled or not.)

Returns:

the field

Throws:

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

setDescription

void setDescription(String newDescription)

Set the value for Description. (The description of this step) This value is optional.

Parameters:

newDescription - the new value for Description.

Throws:

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

setSAPEventId

void setSAPEventId(String newSAPEventId)

Set the value for SAPEventId. (SAP event id mask.) This value is mandatory.

Parameters:

newSAPEventId - the new value for SAPEventId. If this is null, 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.

setSAPEventParameter

void setSAPEventParameter(String newSAPEventParameter)

Set the value for SAPEventParameter. (SAP event parameter mask.) This value is mandatory.

Parameters:

newSAPEventParameter - the new value for SAPEventParameter. If this is null, 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.

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Whether this rule is currently enabled or not.)

Parameters:

newEnabled - the new value for Enabled.

Throws:

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

getEventDefinition

EventDefinition getEventDefinition()

Get the EventDefinition.

Returns:

EventDefinition

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.

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.

setEventDefinition

void setEventDefinition(EventDefinition newEventDefinition)

Set the value for EventDefinition. This value is mandatory.

Parameters:

newEventDefinition - is the object to set EventDefinition to. Which event should be triggered when an SAP event is triggered. If this is null, then the object cannot be persisted.