Package com.redwood.scheduler.api.model

Interface SAPMassActivityParameterSet

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPMassActivityParameterSetComp, SchedulerEntity, SchedulerEntityComp

public interface SAPMassActivityParameterSet
extends SAPMassActivityParameterSetComp, NamedDetailObject, BusinessKeyObject, Readable

Mass Activity parameter set

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPMassActivityParameterSet" 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<SAPMassActivityParameterSet>	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
SAPMassActivityFieldParameter	createSAPMassActivityFieldParameter()	Create a new SAPMassActivityFieldParameter linked to this object.
SAPMassActivityFieldTable	createSAPMassActivityFieldTable()	Create a new SAPMassActivityFieldTable linked to this object.
String	getClientNumber()	Get the value for ClientNumber.
SAPMassActivity	getSAPMassActivity()	Get the SAPMassActivity.
SAPMassActivityFieldParameter	getSAPMassActivityFieldParameterByName(String name)	Get the SAPMassActivityFieldParameter by NameSAPMassActivityParameterSet.
RWIterable<SAPMassActivityFieldParameter>	getSAPMassActivityFieldParameters()	Get an RWIterable over an ordered collection of SAPMassActivityFieldParameters.
SAPMassActivityFieldTable	getSAPMassActivityFieldTableByName(String name)	Get the SAPMassActivityFieldTable by NameSAPMassActivityParameterSet.
RWIterable<SAPMassActivityFieldTable>	getSAPMassActivityFieldTables()	Get an RWIterable over an ordered collection of SAPMassActivityFieldTables.
boolean	isScriptingAllowed()	Get the value for ScriptingAllowed.
void	setClientNumber(String newClientNumber)	Set the value for ClientNumber.
void	setScriptingAllowed(boolean newScriptingAllowed)	Set the value for ScriptingAllowed.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SAPMassActivityParameterSet> 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.

isScriptingAllowed

boolean isScriptingAllowed()

Get the value for ScriptingAllowed. (Is scripting allowed?)

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.

setScriptingAllowed

void setScriptingAllowed(boolean newScriptingAllowed)

Set the value for ScriptingAllowed. (Is scripting allowed?)

Parameters:

newScriptingAllowed - the new value for ScriptingAllowed.

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.

getSAPMassActivity

SAPMassActivity getSAPMassActivity()

Get the SAPMassActivity.

Returns:

SAPMassActivity

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.

getSAPMassActivityFieldParameters

RWIterable<SAPMassActivityFieldParameter> getSAPMassActivityFieldParameters()

Get an RWIterable over an ordered collection of SAPMassActivityFieldParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Mass Activity parameter set field parameters.

Specified by:

getSAPMassActivityFieldParameters in interface SAPMassActivityParameterSetComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityFieldParameter objects .

createSAPMassActivityFieldParameter

SAPMassActivityFieldParameter createSAPMassActivityFieldParameter()

Create a new SAPMassActivityFieldParameter linked to this object.

Returns:

a new SAPMassActivityFieldParameter.

getSAPMassActivityFieldParameterByName

SAPMassActivityFieldParameter getSAPMassActivityFieldParameterByName(String name)

Get the SAPMassActivityFieldParameter by NameSAPMassActivityParameterSet.

Parameters:

name -

Returns:

the SAPMassActivityFieldParameter, or null if it could not be found

getSAPMassActivityFieldTables

RWIterable<SAPMassActivityFieldTable> getSAPMassActivityFieldTables()

Get an RWIterable over an ordered collection of SAPMassActivityFieldTables. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Mass Activity parameter set field tables.

Specified by:

getSAPMassActivityFieldTables in interface SAPMassActivityParameterSetComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityFieldTable objects .

createSAPMassActivityFieldTable

SAPMassActivityFieldTable createSAPMassActivityFieldTable()

Create a new SAPMassActivityFieldTable linked to this object.

Returns:

a new SAPMassActivityFieldTable.

getSAPMassActivityFieldTableByName

SAPMassActivityFieldTable getSAPMassActivityFieldTableByName(String name)

Get the SAPMassActivityFieldTable by NameSAPMassActivityParameterSet.

Parameters:

name -

Returns:

the SAPMassActivityFieldTable, or null if it could not be found