Package com.redwood.scheduler.api.model

Interface SAPNWCallbackVariantDetail

All Superinterfaces:

Detail, Readable, SAPNWCallbackVariantDetailComp, SchedulerEntity, SchedulerEntityComp

public interface SAPNWCallbackVariantDetail
extends SAPNWCallbackVariantDetailComp, Detail, Readable

SAP NW callback variant detail.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPNWCallbackVariantDetail" 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<SAPNWCallbackVariantDetail>	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
SAPNWCallbackParameterMapping	createSAPNWCallbackParameterMapping()	Create a new SAPNWCallbackParameterMapping linked to this object.
String	getCallbackGroup()	Get the value for CallbackGroup.
String	getSAPLanguage()	Get the value for SAPLanguage.
RWIterable<SAPNWCallbackParameterMapping>	getSAPNWCallbackParameterMappings()	Get an RWIterable over an ordered collection of SAPNWCallbackParameterMappings.
SAPNWCallbackVariant	getSAPNWCallbackVariant()	Get the SAPNWCallbackVariant.
SAPNWCallbackScope	getScope()	Get the value for Scope.
String	getText()	Get the value for Text.
String	getURL()	Get the value for URL.
void	setCallbackGroup(String newCallbackGroup)	Set the value for CallbackGroup.
void	setSAPLanguage(String newSAPLanguage)	Set the value for SAPLanguage.
void	setScope(SAPNWCallbackScope newScope)	Set the value for Scope.
void	setText(String newText)	Set the value for Text.
void	setURL(String newURL)	Set the value for URL.

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

See Also:

Constant Field Values

TYPE

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

getText

String getText()

Get the value for Text. (Text.) 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.

getCallbackGroup

String getCallbackGroup()

Get the value for CallbackGroup. (Grouping.)

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.

getURL

String getURL()

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

getSAPLanguage

String getSAPLanguage()

Get the value for SAPLanguage. (SAP language.) 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

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

setText

void setText(String newText)

Set the value for Text. (Text.) This value is mandatory.

Parameters:

newText - the new value for Text. 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.

setCallbackGroup

void setCallbackGroup(String newCallbackGroup)

Set the value for CallbackGroup. (Grouping.) This value is optional.

Parameters:

newCallbackGroup - the new value for CallbackGroup.

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.

setURL

void setURL(String newURL)

Set the value for URL. (Grouping.) This value is mandatory.

Parameters:

newURL - the new value for URL. 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.

setSAPLanguage

void setSAPLanguage(String newSAPLanguage)

Set the value for SAPLanguage. (SAP language.) This value is mandatory.

Parameters:

newSAPLanguage - the new value for SAPLanguage. 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(SAPNWCallbackScope 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.

getSAPNWCallbackVariant

SAPNWCallbackVariant getSAPNWCallbackVariant()

Get the SAPNWCallbackVariant.

Returns:

SAPNWCallbackVariant

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.

getSAPNWCallbackParameterMappings

RWIterable<SAPNWCallbackParameterMapping> getSAPNWCallbackParameterMappings()

Get an RWIterable over an ordered collection of SAPNWCallbackParameterMappings. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Parameters of a NW callback.

Specified by:

getSAPNWCallbackParameterMappings in interface SAPNWCallbackVariantDetailComp

Returns:

An RWIterable over an ordered collection of SAPNWCallbackParameterMapping objects .

createSAPNWCallbackParameterMapping

SAPNWCallbackParameterMapping createSAPNWCallbackParameterMapping()

Create a new SAPNWCallbackParameterMapping linked to this object.

Returns:

a new SAPNWCallbackParameterMapping.