Package com.redwood.scheduler.api.model

Interface SAPBAEConfiguration

All Superinterfaces:

Detail, Readable, SAPCommonSettings, SAPUsernamePassword, SchedulerEntity, SchedulerEntityComp

public interface SAPBAEConfiguration
extends SAPCommonSettings, Readable

SAP Business Application Enabler configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPBAEConfiguration" 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<SAPBAEConfiguration>	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
Long	getNumberOfRfcServers()	Get the value for NumberOfRfcServers.
String	getRFCDestination()	Get the value for RFCDestination.
SAPBAEConnector	getSAPBAEConnector()	Get the SAPBAEConnector.
boolean	isDefaultScheduler()	Get the value for DefaultScheduler.
void	setDefaultScheduler(boolean newDefaultScheduler)	Set the value for DefaultScheduler.
void	setNumberOfRfcServers(Long newNumberOfRfcServers)	Set the value for NumberOfRfcServers.
void	setRFCDestination(String newRFCDestination)	Set the value for RFCDestination.

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

checkConnectionSettings, getAuditLevel, getClientNumber, getDescription, getInterfaceVersion, getMaximumNumberOfRFCConnections, getSAPLanguage, isEnabled, isSNCConnection, setAuditLevel, setClientNumber, setDescription, setEnabled, setInterfaceVersion, setMaximumNumberOfRFCConnections, setSAPLanguage

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

getPassword, getUsername, setPassword, setUsername

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

See Also:

Constant Field Values

TYPE

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

isDefaultScheduler

boolean isDefaultScheduler()

Get the value for DefaultScheduler. (Whether this BAE connector should register itself as the default scheduler.)

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.

getRFCDestination

String getRFCDestination()

Get the value for RFCDestination. (RFC destination name.)

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.

getNumberOfRfcServers

Long getNumberOfRfcServers()

Get the value for NumberOfRfcServers. (Number of RFC servers to connect to the SAP system.) 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.

setDefaultScheduler

void setDefaultScheduler(boolean newDefaultScheduler)

Set the value for DefaultScheduler. (Whether this BAE connector should register itself as the default scheduler.)

Parameters:

newDefaultScheduler - the new value for DefaultScheduler.

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.

setRFCDestination

void setRFCDestination(String newRFCDestination)

Set the value for RFCDestination. (RFC destination name.) This value is optional.

Parameters:

newRFCDestination - the new value for RFCDestination.

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.

setNumberOfRfcServers

void setNumberOfRfcServers(Long newNumberOfRfcServers)

Set the value for NumberOfRfcServers. (Number of RFC servers to connect to the SAP system.) This value is mandatory.

Parameters:

newNumberOfRfcServers - the new value for NumberOfRfcServers. 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.

getSAPBAEConnector

SAPBAEConnector getSAPBAEConnector()

Get the SAPBAEConnector.

Returns:

SAPBAEConnector

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.