Package com.redwood.scheduler.api.model

Interface SAPAbapVariant

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPAbapVariantComp, SchedulerEntity, SchedulerEntityComp

public interface SAPAbapVariant
extends SAPAbapVariantComp, NamedDetailObject, BusinessKeyObject, Readable

ABAP variant details.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPAbapVariant" 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<SAPAbapVariant>	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
SAPAbapVariantParameter	createSAPAbapVariantParameter()	Create a new SAPAbapVariantParameter linked to this object.
SAPAbapVariantParameterValue	createSAPAbapVariantParameterValue()	Create a new SAPAbapVariantParameterValue linked to this object.
SAPAbapVariantSelopt	createSAPAbapVariantSelopt()	Create a new SAPAbapVariantSelopt linked to this object.
String	getClientNumber()	Get the value for ClientNumber.
SAPAbapProgram	getSAPAbapProgram()	Get the SAPAbapProgram.
RWIterable<SAPAbapVariantParameter>	getSAPAbapVariantParameters()	Get an RWIterable over an ordered collection of SAPAbapVariantParameters.
SAPAbapVariantParameterValue	getSAPAbapVariantParameterValueByName(String name)	Get the SAPAbapVariantParameterValue by NameSAPAbapVariantParameterValue.
RWIterable<SAPAbapVariantParameterValue>	getSAPAbapVariantParameterValues()	Get an RWIterable over an ordered collection of SAPAbapVariantParameterValues.
SAPAbapVariantSelopt	getSAPAbapVariantSeloptByName(String name)	Get the SAPAbapVariantSelopt by NameSAPAbapVariantSelopt.
RWIterable<SAPAbapVariantSelopt>	getSAPAbapVariantSelopts()	Get an RWIterable over an ordered collection of SAPAbapVariantSelopts.
String	getSAPLanguage()	Get the value for SAPLanguage.
boolean	isBackgroundOnly()	Get the value for BackgroundOnly.
boolean	isProtected()	Get the value for Protected.
boolean	isSystem()	Get the value for System.
void	setBackgroundOnly(boolean newBackgroundOnly)	Set the value for BackgroundOnly.
void	setClientNumber(String newClientNumber)	Set the value for ClientNumber.
void	setProtected(boolean newProtected)	Set the value for Protected.
void	setSAPLanguage(String newSAPLanguage)	Set the value for SAPLanguage.
void	setSystem(boolean newSystem)	Set the value for System.

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

OBJECT_TYPE

static final String OBJECT_TYPE

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

See Also:

Constant Field Values

TYPE

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

getClientNumber

String getClientNumber()

Get the value for ClientNumber. (Client number.) 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.

isProtected

boolean isProtected()

Get the value for Protected. (Indicates if this variant is protected.)

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.

isBackgroundOnly

boolean isBackgroundOnly()

Get the value for BackgroundOnly. (Indicates if this variant can be used in background processing only.)

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.

isSystem

boolean isSystem()

Get the value for System. (Indicates if this is a system variant.)

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.

setClientNumber

void setClientNumber(String newClientNumber)

Set the value for ClientNumber. (Client number.) This value is mandatory.

Parameters:

newClientNumber - the new value for ClientNumber. 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.

setProtected

void setProtected(boolean newProtected)

Set the value for Protected. (Indicates if this variant is protected.)

Parameters:

newProtected - the new value for Protected.

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.

setBackgroundOnly

void setBackgroundOnly(boolean newBackgroundOnly)

Set the value for BackgroundOnly. (Indicates if this variant can be used in background processing only.)

Parameters:

newBackgroundOnly - the new value for BackgroundOnly.

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.

setSystem

void setSystem(boolean newSystem)

Set the value for System. (Indicates if this is a system variant.)

Parameters:

newSystem - the new value for System.

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.

getSAPAbapProgram

SAPAbapProgram getSAPAbapProgram()

Get the SAPAbapProgram.

Returns:

SAPAbapProgram

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.

getSAPAbapVariantParameters

RWIterable<SAPAbapVariantParameter> getSAPAbapVariantParameters()

Get an RWIterable over an ordered collection of SAPAbapVariantParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Variants of the ABAP programs imported from the SAP system.

Specified by:

getSAPAbapVariantParameters in interface SAPAbapVariantComp

Returns:

An RWIterable over an ordered collection of SAPAbapVariantParameter objects .

createSAPAbapVariantParameter

SAPAbapVariantParameter createSAPAbapVariantParameter()

Create a new SAPAbapVariantParameter linked to this object.

Returns:

a new SAPAbapVariantParameter.

getSAPAbapVariantParameterValues

RWIterable<SAPAbapVariantParameterValue> getSAPAbapVariantParameterValues()

Get an RWIterable over an ordered collection of SAPAbapVariantParameterValues. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Variant parameter values of the ABAP program variant imported from the SAP system.

Specified by:

getSAPAbapVariantParameterValues in interface SAPAbapVariantComp

Returns:

An RWIterable over an ordered collection of SAPAbapVariantParameterValue objects .

createSAPAbapVariantParameterValue

SAPAbapVariantParameterValue createSAPAbapVariantParameterValue()

Create a new SAPAbapVariantParameterValue linked to this object.

Returns:

a new SAPAbapVariantParameterValue.

getSAPAbapVariantParameterValueByName

SAPAbapVariantParameterValue getSAPAbapVariantParameterValueByName(String name)

Get the SAPAbapVariantParameterValue by NameSAPAbapVariantParameterValue.

Parameters:

name -

Returns:

the SAPAbapVariantParameterValue, or null if it could not be found

getSAPAbapVariantSelopts

RWIterable<SAPAbapVariantSelopt> getSAPAbapVariantSelopts()

Get an RWIterable over an ordered collection of SAPAbapVariantSelopts. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Variant select option values of the ABAP program variant imported from the SAP system.

Specified by:

getSAPAbapVariantSelopts in interface SAPAbapVariantComp

Returns:

An RWIterable over an ordered collection of SAPAbapVariantSelopt objects .

createSAPAbapVariantSelopt

SAPAbapVariantSelopt createSAPAbapVariantSelopt()

Create a new SAPAbapVariantSelopt linked to this object.

Returns:

a new SAPAbapVariantSelopt.

getSAPAbapVariantSeloptByName

SAPAbapVariantSelopt getSAPAbapVariantSeloptByName(String name)

Get the SAPAbapVariantSelopt by NameSAPAbapVariantSelopt.

Parameters:

name -

Returns:

the SAPAbapVariantSelopt, or null if it could not be found