Package com.redwood.scheduler.api.model

Interface SAPApplicationServer

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPApplicationServerComp, SchedulerEntity, SchedulerEntityComp

public interface SAPApplicationServer
extends SAPApplicationServerComp, NamedDetailObject, BusinessKeyObject, Readable

Settings relating to a SAP Application Server.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPApplicationServer" 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<SAPApplicationServer>	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
SAPApplicationServerLoadFactor	createSAPApplicationServerLoadFactor()	Create a new SAPApplicationServerLoadFactor linked to this object.
SAPApplicationServerProvider	createSAPApplicationServerProvider(SAPApplicationServerGroup newSAPApplicationServerGroup)	Create a new SAPApplicationServerProvider linked to this object.
Long	getLoad()	Get the value for Load.
Long	getLoadThreshold()	Get the value for LoadThreshold.
Long	getNumberOfClassAWorkProcesses()	Get the value for NumberOfClassAWorkProcesses.
Long	getNumberOfWorkProcesses()	Get the value for NumberOfWorkProcesses.
RWIterable<SAPApplicationServerLoadFactor>	getSAPApplicationServerLoadFactors()	Get an RWIterable over an ordered collection of SAPApplicationServerLoadFactors.
SAPApplicationServerProvider	getSAPApplicationServerProviderBySAPApplicationServerGroup(SAPApplicationServerGroup sAPApplicationServerGroup)	Get the SAPApplicationServerProvider by SAPAppSrvProvider.
RWIterable<SAPApplicationServerProvider>	getSAPApplicationServerProviders()	Get an RWIterable over an ordered collection of SAPApplicationServerProviders.
SAPSystem	getSAPSystem()	Get the SAPSystem.
boolean	isActive()	Get the value for Active.
boolean	isEnabled()	Get the value for Enabled.
boolean	isOverloaded()	Return if the SAPApplicationServer is currently overloaded or not.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setLoadThreshold(Long newLoadThreshold)	Set the value for LoadThreshold.
void	setNumberOfClassAWorkProcesses(Long newNumberOfClassAWorkProcesses)	Set the value for NumberOfClassAWorkProcesses.
void	setNumberOfWorkProcesses(Long newNumberOfWorkProcesses)	Set the value for NumberOfWorkProcesses.

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

See Also:

Constant Field Values

TYPE

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

getLoadThreshold

Long getLoadThreshold()

Get the value for LoadThreshold. (The maximum load the server can support before being marked as overloaded.)

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.

getLoad

Long getLoad()

Get the value for Load. (Get the current load of the SAP Application Server.) 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.

isActive

boolean isActive()

Get the value for Active. (Whether this application server is currently up and running or not.)

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.

isEnabled

boolean isEnabled()

Get the value for Enabled. (Whether this application server is currently enabled for load balancing or not.)

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.

getNumberOfWorkProcesses

Long getNumberOfWorkProcesses()

Get the value for NumberOfWorkProcesses. (Total number of work processes.) 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.

getNumberOfClassAWorkProcesses

Long getNumberOfClassAWorkProcesses()

Get the value for NumberOfClassAWorkProcesses. (Number of class A work processes.) 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.

setLoadThreshold

void setLoadThreshold(Long newLoadThreshold)

Set the value for LoadThreshold. (The maximum load the server can support before being marked as overloaded.) This value is optional.

Parameters:

newLoadThreshold - the new value for LoadThreshold.

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.

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Whether this application server is currently enabled for load balancing or not.)

Parameters:

newEnabled - the new value for Enabled.

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.

setNumberOfWorkProcesses

void setNumberOfWorkProcesses(Long newNumberOfWorkProcesses)

Set the value for NumberOfWorkProcesses. (Total number of work processes.) This value is mandatory.

Parameters:

newNumberOfWorkProcesses - the new value for NumberOfWorkProcesses. 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.

setNumberOfClassAWorkProcesses

void setNumberOfClassAWorkProcesses(Long newNumberOfClassAWorkProcesses)

Set the value for NumberOfClassAWorkProcesses. (Number of class A work processes.) This value is mandatory.

Parameters:

newNumberOfClassAWorkProcesses - the new value for NumberOfClassAWorkProcesses. 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.

isOverloaded

boolean isOverloaded()

Return if the SAPApplicationServer is currently overloaded or not. Return if the SAPApplicationServer is currently overloaded or not. This is calculated from the SAPApplicationServerLoadFactors whenever a call to the getLoad function is made.

Returns:

The overloaded status of the SAPApplicationServer.

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.

getSAPApplicationServerLoadFactors

RWIterable<SAPApplicationServerLoadFactor> getSAPApplicationServerLoadFactors()

Get an RWIterable over an ordered collection of SAPApplicationServerLoadFactors. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The load factors of this SAP Application Server.

Specified by:

getSAPApplicationServerLoadFactors in interface SAPApplicationServerComp

Returns:

An RWIterable over an ordered collection of SAPApplicationServerLoadFactor objects .

createSAPApplicationServerLoadFactor

SAPApplicationServerLoadFactor createSAPApplicationServerLoadFactor()

Create a new SAPApplicationServerLoadFactor linked to this object.

Returns:

a new SAPApplicationServerLoadFactor.

getSAPApplicationServerProviders

RWIterable<SAPApplicationServerProvider> getSAPApplicationServerProviders()

Get an RWIterable over an ordered collection of SAPApplicationServerProviders. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The SAP Application Server Groups of this SAP Application Server.

Specified by:

getSAPApplicationServerProviders in interface SAPApplicationServerComp

Returns:

An RWIterable over an ordered collection of SAPApplicationServerProvider objects .

createSAPApplicationServerProvider

SAPApplicationServerProvider createSAPApplicationServerProvider(SAPApplicationServerGroup newSAPApplicationServerGroup)

Create a new SAPApplicationServerProvider linked to this object.

Parameters:

newSAPApplicationServerGroup - The other parent of the SAPApplicationServerProviderSAPApplicationServerGroup association.

Returns:

a new SAPApplicationServerProvider.

getSAPApplicationServerProviderBySAPApplicationServerGroup

SAPApplicationServerProvider getSAPApplicationServerProviderBySAPApplicationServerGroup(SAPApplicationServerGroup sAPApplicationServerGroup)

Get the SAPApplicationServerProvider by SAPAppSrvProvider.

Parameters:

sAPApplicationServerGroup -

Returns:

the SAPApplicationServerProvider, or null if it could not be found