Package com.redwood.scheduler.api.model

Interface SAPMassActivityLayoutField

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface SAPMassActivityLayoutField
extends NamedDetailObject, BusinessKeyObject, Readable

Mass Activity field

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPMassActivityLayoutField" 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<SAPMassActivityLayoutField>	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	getClientNumber()	Get the value for ClientNumber.
String	getLayoutField()	Get the value for LayoutField.
String	getLayoutTab()	Get the value for LayoutTab.
Long	getLayoutTabNr()	Get the value for LayoutTabNr.
Long	getPosition()	Get the value for Position.
SAPMassActivity	getSAPMassActivity()	Get the SAPMassActivity.
SAPMassActivityParameter	getSAPMassActivityParameter()	Get the SAPMassActivityParameter.
void	setClientNumber(String newClientNumber)	Set the value for ClientNumber.
void	setLayoutField(String newLayoutField)	Set the value for LayoutField.
void	setLayoutTab(String newLayoutTab)	Set the value for LayoutTab.
void	setLayoutTabNr(Long newLayoutTabNr)	Set the value for LayoutTabNr.
void	setPosition(Long newPosition)	Set the value for Position.
void	setSAPMassActivityParameter(SAPMassActivityParameter newSAPMassActivityParameter)	Set the value for SAPMassActivityParameter.

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

See Also:

Constant Field Values

TYPE

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

getLayoutTabNr

Long getLayoutTabNr()

Get the value for LayoutTabNr. (Layout tab)

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.

getLayoutTab

String getLayoutTab()

Get the value for LayoutTab. (Layout tab)

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.

getLayoutField

String getLayoutField()

Get the value for LayoutField. (Layout field)

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.

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.

setLayoutTabNr

void setLayoutTabNr(Long newLayoutTabNr)

Set the value for LayoutTabNr. (Layout tab) This value is optional.

Parameters:

newLayoutTabNr - the new value for LayoutTabNr.

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.

setLayoutTab

void setLayoutTab(String newLayoutTab)

Set the value for LayoutTab. (Layout tab) This value is optional.

Parameters:

newLayoutTab - the new value for LayoutTab.

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.

setLayoutField

void setLayoutField(String newLayoutField)

Set the value for LayoutField. (Layout field) This value is optional.

Parameters:

newLayoutField - the new value for LayoutField.

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.

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.

getSAPMassActivityParameter

SAPMassActivityParameter getSAPMassActivityParameter()

Get the SAPMassActivityParameter.

Returns:

SAPMassActivityParameter

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.

setSAPMassActivityParameter

void setSAPMassActivityParameter(SAPMassActivityParameter newSAPMassActivityParameter)

Set the value for SAPMassActivityParameter. This value is optional.

Parameters:

newSAPMassActivityParameter - is the object to set SAPMassActivityParameter to. Link the Mass Activity field its corresponding parameter.