Package com.redwood.scheduler.api.model

Interface SAPNWCallbackParameterMapping

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface SAPNWCallbackParameterMapping
extends Detail

SAP NW callback parameter mapping.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPNWCallbackParameterMapping" 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<SAPNWCallbackParameterMapping>	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	getCPSParameter()	Get the value for CPSParameter.
SAPNWCallbackVariantDetail	getSAPNWCallbackVariantDetail()	Get the SAPNWCallbackVariantDetail.
SAPNWCallbackParameterScope	getScope()	Get the value for Scope.
String	getURLParameter()	Get the value for URLParameter.
void	setCPSParameter(String newCPSParameter)	Set the value for CPSParameter.
void	setScope(SAPNWCallbackParameterScope newScope)	Set the value for Scope.
void	setURLParameter(String newURLParameter)	Set the value for URLParameter.

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

See Also:

Constant Field Values

TYPE

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

getCPSParameter

String getCPSParameter()

Get the value for CPSParameter. (CPS parameter.) 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.

getURLParameter

String getURLParameter()

Get the value for URLParameter. (URL parameter.) 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.

getScope

SAPNWCallbackParameterScope getScope()

Get the value for Scope. (Scope of the callback.) 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.

setCPSParameter

void setCPSParameter(String newCPSParameter)

Set the value for CPSParameter. (CPS parameter.) This value is mandatory.

Parameters:

newCPSParameter - the new value for CPSParameter. 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.

setURLParameter

void setURLParameter(String newURLParameter)

Set the value for URLParameter. (URL parameter.) This value is mandatory.

Parameters:

newURLParameter - the new value for URLParameter. 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.

setScope

void setScope(SAPNWCallbackParameterScope newScope)

Set the value for Scope. (Scope of the callback.) This value is mandatory.

Parameters:

newScope - the new value for Scope. 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.

getSAPNWCallbackVariantDetail

SAPNWCallbackVariantDetail getSAPNWCallbackVariantDetail()

Get the SAPNWCallbackVariantDetail.

Returns:

SAPNWCallbackVariantDetail

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.