Package com.redwood.scheduler.api.model

Interface SAPMassActivity

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPMassActivityComp, SchedulerEntity, SchedulerEntityComp

public interface SAPMassActivity
extends SAPMassActivityComp, NamedDetailObject, BusinessKeyObject, Readable

Mass Activity

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPMassActivity" 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<SAPMassActivity>	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
SAPMassActivityLayoutField	createSAPMassActivityLayoutField()	Create a new SAPMassActivityLayoutField linked to this object.
SAPMassActivityObject	createSAPMassActivityObject()	Create a new SAPMassActivityObject linked to this object.
SAPMassActivityParameterSet	createSAPMassActivityParameterSet()	Create a new SAPMassActivityParameterSet linked to this object.
SAPMassActivityStructure	createSAPMassActivityStructure()	Create a new SAPMassActivityStructure linked to this object.
String	getAddOnsStructure()	Get the value for AddOnsStructure.
String	getBasicsStructure()	Get the value for BasicsStructure.
String	getJType()	Get the value for JType.
String	getSAPLanguage()	Get the value for SAPLanguage.
SAPMassActivityLayoutField	getSAPMassActivityLayoutFieldByNameClientNumber(String name, String clientNumber)	Get the SAPMassActivityLayoutField by NameSAPMassActivity.
RWIterable<SAPMassActivityLayoutField>	getSAPMassActivityLayoutFields()	Get an RWIterable over an ordered collection of SAPMassActivityLayoutFields.
SAPMassActivityObject	getSAPMassActivityObjectByName(String name)	Get the SAPMassActivityObject by NameSAPMassActivity.
RWIterable<SAPMassActivityObject>	getSAPMassActivityObjects()	Get an RWIterable over an ordered collection of SAPMassActivityObjects.
SAPMassActivityParameterSet	getSAPMassActivityParameterSetByNameClientNumber(String name, String clientNumber)	Get the SAPMassActivityParameterSet by NameSAPMassActivity.
RWIterable<SAPMassActivityParameterSet>	getSAPMassActivityParameterSets()	Get an RWIterable over an ordered collection of SAPMassActivityParameterSets.
SAPMassActivityStructure	getSAPMassActivityStructureByName(String name)	Get the SAPMassActivityStructure by NameSAPMassActivity.
RWIterable<SAPMassActivityStructure>	getSAPMassActivityStructures()	Get an RWIterable over an ordered collection of SAPMassActivityStructures.
SAPSystem	getSAPSystem()	Get the SAPSystem.
String	getTransaction()	Get the value for Transaction.
void	setAddOnsStructure(String newAddOnsStructure)	Set the value for AddOnsStructure.
void	setBasicsStructure(String newBasicsStructure)	Set the value for BasicsStructure.
void	setJType(String newJType)	Set the value for JType.
void	setSAPLanguage(String newSAPLanguage)	Set the value for SAPLanguage.
void	setTransaction(String newTransaction)	Set the value for Transaction.

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

See Also:

Constant Field Values

TYPE

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

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.

getJType

String getJType()

Get the value for JType. (JType.)

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.

getBasicsStructure

String getBasicsStructure()

Get the value for BasicsStructure. (Name of the basics structure.)

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.

getAddOnsStructure

String getAddOnsStructure()

Get the value for AddOnsStructure. (Name of the add-ons structure.)

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.

getTransaction

String getTransaction()

Get the value for Transaction. (Transaction)

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.

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.

setJType

void setJType(String newJType)

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

Parameters:

newJType - the new value for JType.

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.

setBasicsStructure

void setBasicsStructure(String newBasicsStructure)

Set the value for BasicsStructure. (Name of the basics structure.) This value is optional.

Parameters:

newBasicsStructure - the new value for BasicsStructure.

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.

setAddOnsStructure

void setAddOnsStructure(String newAddOnsStructure)

Set the value for AddOnsStructure. (Name of the add-ons structure.) This value is optional.

Parameters:

newAddOnsStructure - the new value for AddOnsStructure.

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.

setTransaction

void setTransaction(String newTransaction)

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

Parameters:

newTransaction - the new value for Transaction.

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.

getSAPSystem

SAPSystem getSAPSystem()

Get the SAPSystem.

Returns:

SAPSystem

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.

getSAPMassActivityLayoutFields

RWIterable<SAPMassActivityLayoutField> getSAPMassActivityLayoutFields()

Get an RWIterable over an ordered collection of SAPMassActivityLayoutFields. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Mass Activity layout fields.

Specified by:

getSAPMassActivityLayoutFields in interface SAPMassActivityComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityLayoutField objects .

createSAPMassActivityLayoutField

SAPMassActivityLayoutField createSAPMassActivityLayoutField()

Create a new SAPMassActivityLayoutField linked to this object.

Returns:

a new SAPMassActivityLayoutField.

getSAPMassActivityLayoutFieldByNameClientNumber

SAPMassActivityLayoutField getSAPMassActivityLayoutFieldByNameClientNumber(String name,
                                                                           String clientNumber)

Get the SAPMassActivityLayoutField by NameSAPMassActivity.

Parameters:

name -

clientNumber -

Returns:

the SAPMassActivityLayoutField, or null if it could not be found

getSAPMassActivityObjects

RWIterable<SAPMassActivityObject> getSAPMassActivityObjects()

Get an RWIterable over an ordered collection of SAPMassActivityObjects. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Mass Activity objects.

Specified by:

getSAPMassActivityObjects in interface SAPMassActivityComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityObject objects .

createSAPMassActivityObject

SAPMassActivityObject createSAPMassActivityObject()

Create a new SAPMassActivityObject linked to this object.

Returns:

a new SAPMassActivityObject.

getSAPMassActivityObjectByName

SAPMassActivityObject getSAPMassActivityObjectByName(String name)

Get the SAPMassActivityObject by NameSAPMassActivity.

Parameters:

name -

Returns:

the SAPMassActivityObject, or null if it could not be found

getSAPMassActivityStructures

RWIterable<SAPMassActivityStructure> getSAPMassActivityStructures()

Get an RWIterable over an ordered collection of SAPMassActivityStructures. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Mass Activity structures.

Specified by:

getSAPMassActivityStructures in interface SAPMassActivityComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityStructure objects .

createSAPMassActivityStructure

SAPMassActivityStructure createSAPMassActivityStructure()

Create a new SAPMassActivityStructure linked to this object.

Returns:

a new SAPMassActivityStructure.

getSAPMassActivityStructureByName

SAPMassActivityStructure getSAPMassActivityStructureByName(String name)

Get the SAPMassActivityStructure by NameSAPMassActivity.

Parameters:

name -

Returns:

the SAPMassActivityStructure, or null if it could not be found

getSAPMassActivityParameterSets

RWIterable<SAPMassActivityParameterSet> getSAPMassActivityParameterSets()

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

Specified by:

getSAPMassActivityParameterSets in interface SAPMassActivityComp

Returns:

An RWIterable over an ordered collection of SAPMassActivityParameterSet objects .

createSAPMassActivityParameterSet

SAPMassActivityParameterSet createSAPMassActivityParameterSet()

Create a new SAPMassActivityParameterSet linked to this object.

Returns:

a new SAPMassActivityParameterSet.

getSAPMassActivityParameterSetByNameClientNumber

SAPMassActivityParameterSet getSAPMassActivityParameterSetByNameClientNumber(String name,
                                                                             String clientNumber)

Get the SAPMassActivityParameterSet by NameSAPMassActivity.

Parameters:

name -

clientNumber -

Returns:

the SAPMassActivityParameterSet, or null if it could not be found