Package com.redwood.scheduler.api.model

Interface VisualizationPSQText

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface VisualizationPSQText
extends Detail

A text box 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 "VisualizationPSQText" 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<VisualizationPSQText>	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
VisualizationFontSize	getFontSize()	Get the value for FontSize.
BigDecimal	getLeftPosition()	Get the value for LeftPosition.
String	getText()	Get the value for Text.
BigDecimal	getTopPosition()	Get the value for TopPosition.
VisualizationProcessServerQueue	getVisualizationProcessServerQueue()	Get the VisualizationProcessServerQueue.
BigDecimal	getWidth()	Get the value for Width.
boolean	isVisible()	Get the value for Visible.
void	setFontSize(VisualizationFontSize newFontSize)	Set the value for FontSize.
void	setLeftPosition(BigDecimal newLeftPosition)	Set the value for LeftPosition.
void	setText(String newText)	Set the value for Text.
void	setTopPosition(BigDecimal newTopPosition)	Set the value for TopPosition.
void	setVisible(boolean newVisible)	Set the value for Visible.
void	setWidth(BigDecimal newWidth)	Set the value for Width.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<VisualizationPSQText> 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 text box 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 text box.)

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 left position of the text box.)

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.

getWidth

BigDecimal getWidth()

Get the value for Width. (The width of the text box.)

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.

getFontSize

VisualizationFontSize getFontSize()

Get the value for FontSize. (The font size of the text box.) 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.

getText

String getText()

Get the value for Text. (The text in the text box.) 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 text box 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 text box.) 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 left position of the text box.) 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.

setWidth

void setWidth(BigDecimal newWidth)

Set the value for Width. (The width of the text box.) This value is optional.

Parameters:

newWidth - the new value for Width.

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.

setFontSize

void setFontSize(VisualizationFontSize newFontSize)

Set the value for FontSize. (The font size of the text box.) This value is mandatory.

Parameters:

newFontSize - the new value for FontSize. 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.

setText

void setText(String newText)

Set the value for Text. (The text in the text box.) This value is mandatory.

Parameters:

newText - the new value for Text. 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.