Package com.redwood.scheduler.api.model

Interface VisualizationPSQProcessServer

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface VisualizationPSQProcessServer
extends Detail

A process server in a process server and queue visualization

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "VisualizationPSQProcessServer" 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<VisualizationPSQProcessServer>	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
BigDecimal	getLeftPosition()	Get the value for LeftPosition.
BigDecimal	getMaxLoad()	Get the value for MaxLoad.
ProcessServer	getProcessServer()	Get the ProcessServer.
BigDecimal	getTopPosition()	Get the value for TopPosition.
VisualizationProcessServerQueue	getVisualizationProcessServerQueue()	Get the VisualizationProcessServerQueue.
boolean	isVisible()	Get the value for Visible.
void	setLeftPosition(BigDecimal newLeftPosition)	Set the value for LeftPosition.
void	setMaxLoad(BigDecimal newMaxLoad)	Set the value for MaxLoad.
void	setProcessServer(ProcessServer newProcessServer)	Set the value for ProcessServer.
void	setTopPosition(BigDecimal newTopPosition)	Set the value for TopPosition.
void	setVisible(boolean newVisible)	Set the value for Visible.

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

See Also:

Constant Field Values

TYPE

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

isVisible

boolean isVisible()

Get the value for Visible. (Show this process server in the visualization.)

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.

getLeftPosition

BigDecimal getLeftPosition()

Get the value for LeftPosition. (The left position of the process server.)

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.

getTopPosition

BigDecimal getTopPosition()

Get the value for TopPosition. (The top position of the process server.)

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.

getMaxLoad

BigDecimal getMaxLoad()

Get the value for MaxLoad. (The maximum load of the process 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.

setVisible

void setVisible(boolean newVisible)

Set the value for Visible. (Show this process server in the visualization.)

Parameters:

newVisible - the new value for Visible.

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.

setLeftPosition

void setLeftPosition(BigDecimal newLeftPosition)

Set the value for LeftPosition. (The left position of the process server.) This value is optional.

Parameters:

newLeftPosition - the new value for LeftPosition.

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.

setTopPosition

void setTopPosition(BigDecimal newTopPosition)

Set the value for TopPosition. (The top position of the process server.) This value is optional.

Parameters:

newTopPosition - the new value for TopPosition.

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.

setMaxLoad

void setMaxLoad(BigDecimal newMaxLoad)

Set the value for MaxLoad. (The maximum load of the process server.) This value is mandatory.

Parameters:

newMaxLoad - the new value for MaxLoad. 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.

getVisualizationProcessServerQueue

VisualizationProcessServerQueue getVisualizationProcessServerQueue()

Get the VisualizationProcessServerQueue.

Returns:

VisualizationProcessServerQueue

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.

getProcessServer

ProcessServer getProcessServer()

Get the ProcessServer.

Returns:

ProcessServer

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.

setProcessServer

void setProcessServer(ProcessServer newProcessServer)

Set the value for ProcessServer. This value is mandatory.

Parameters:

newProcessServer - is the object to set ProcessServer to. The process server If this is null, then the object cannot be persisted.