Package com.redwood.scheduler.api.model

Interface SAPMassActivityParameter

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPMassActivityParameterComp, SchedulerEntity, SchedulerEntityComp

public interface SAPMassActivityParameter
extends SAPMassActivityParameterComp, NamedDetailObject, BusinessKeyObject, Readable

Mass Activity parameter

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPMassActivityParameter" 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<SAPMassActivityParameter>	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
RWIterable<SAPMassActivityParameter>	getChildSAPMassActivityParameters()	Get an RWIterable over an ordered collection of ChildSAPMassActivityParameters.
String	getDatatype()	Get the value for Datatype.
String	getFieldName()	Get the value for FieldName.
Long	getLength()	Get the value for Length.
SAPMassActivityParameter	getParentSAPMassActivityParameter()	Get the ParentSAPMassActivityParameter.
Long	getPosition()	Get the value for Position.
String	getRollname()	Get the value for Rollname.
SAPMassActivityStructure	getSAPMassActivityStructure()	Get the SAPMassActivityStructure.
String	getStructureName()	Get the value for StructureName.
SAPMassActivityParameterType	getType()	Get the value for Type.
boolean	isMandatory()	Get the value for Mandatory.
void	setDatatype(String newDatatype)	Set the value for Datatype.
void	setFieldName(String newFieldName)	Set the value for FieldName.
void	setLength(Long newLength)	Set the value for Length.
void	setMandatory(boolean newMandatory)	Set the value for Mandatory.
void	setParentSAPMassActivityParameter(SAPMassActivityParameter newParentSAPMassActivityParameter)	Set the value for ParentSAPMassActivityParameter.
void	setPosition(Long newPosition)	Set the value for Position.
void	setRollname(String newRollname)	Set the value for Rollname.
void	setStructureName(String newStructureName)	Set the value for StructureName.
void	setType(SAPMassActivityParameterType newType)	Set the value for Type.

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

See Also:

Constant Field Values

TYPE

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

getRollname

String getRollname()

Get the value for Rollname. (Rollname)

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.

getType

SAPMassActivityParameterType getType()

Get the value for Type. (Parameter type.) 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.

getPosition

Long getPosition()

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

getDatatype

String getDatatype()

Get the value for Datatype. (Data type) 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.

getLength

Long getLength()

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

isMandatory

boolean isMandatory()

Get the value for Mandatory. (Whether this field is mandatory)

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.

getFieldName

String getFieldName()

Get the value for FieldName. ("Field 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.

getStructureName

String getStructureName()

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

setRollname

void setRollname(String newRollname)

Set the value for Rollname. (Rollname) This value is optional.

Parameters:

newRollname - the new value for Rollname.

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.

setType

void setType(SAPMassActivityParameterType newType)

Set the value for Type. (Parameter type.) This value is mandatory.

Parameters:

newType - the new value for Type. 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.

setPosition

void setPosition(Long newPosition)

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

Parameters:

newPosition - the new value for Position. 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.

setDatatype

void setDatatype(String newDatatype)

Set the value for Datatype. (Data type) This value is mandatory.

Parameters:

newDatatype - the new value for Datatype. 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.

setLength

void setLength(Long newLength)

Set the value for Length. ("Length") This value is mandatory.

Parameters:

newLength - the new value for Length. 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.

setMandatory

void setMandatory(boolean newMandatory)

Set the value for Mandatory. (Whether this field is mandatory)

Parameters:

newMandatory - the new value for Mandatory.

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.

setFieldName

void setFieldName(String newFieldName)

Set the value for FieldName. ("Field name") This value is optional.

Parameters:

newFieldName - the new value for FieldName.

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.

setStructureName

void setStructureName(String newStructureName)

Set the value for StructureName. (Structure) This value is mandatory.

Parameters:

newStructureName - the new value for StructureName. 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.

getSAPMassActivityStructure

SAPMassActivityStructure getSAPMassActivityStructure()

Get the SAPMassActivityStructure.

Returns:

SAPMassActivityStructure

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.

getParentSAPMassActivityParameter

SAPMassActivityParameter getParentSAPMassActivityParameter()

Get the ParentSAPMassActivityParameter.

Returns:

ParentSAPMassActivityParameter

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.

setParentSAPMassActivityParameter

void setParentSAPMassActivityParameter(SAPMassActivityParameter newParentSAPMassActivityParameter)

Set the value for ParentSAPMassActivityParameter. This value is optional.

Parameters:

newParentSAPMassActivityParameter - is the object to set ParentSAPMassActivityParameter to. Parent-child relationship for Mass Activity parameters.

getChildSAPMassActivityParameters

RWIterable<SAPMassActivityParameter> getChildSAPMassActivityParameters()

Get an RWIterable over an ordered collection of ChildSAPMassActivityParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Parent-child relationship for Mass Activity parameters.

Specified by:

getChildSAPMassActivityParameters in interface SAPMassActivityParameterComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityParameter objects .