Package com.redwood.scheduler.api.model
Interface VisualizationPSQQueue
-
- All Superinterfaces:
Detail
,SchedulerEntity
,SchedulerEntityComp
public interface VisualizationPSQQueue extends Detail
A queue in a process server and queue visualization
-
-
Field Summary
Fields Modifier and Type Field Description static String
OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "VisualizationPSQQueue" 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<VisualizationPSQQueue>
TYPE
Type that can be used inSchedulerSession.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description BigDecimal
getLeftPosition()
Get the value for LeftPosition.Queue
getQueue()
Get the Queue.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
setQueue(Queue newQueue)
Set the value for Queue.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 fromSchedulerEntity.getObjectType()
for "VisualizationPSQQueue" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<VisualizationPSQQueue> TYPE
Type that can be used inSchedulerSession.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 queue in the visualization.)- Returns:
- the field
- Throws:
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 queue.)- Returns:
- the field
- Throws:
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 queue.)- Returns:
- the field
- Throws:
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 queue in the visualization.)- Parameters:
newVisible
- the new value for Visible.- Throws:
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 queue.) This value is optional.- Parameters:
newLeftPosition
- the new value for LeftPosition.- Throws:
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 queue.) This value is optional.- Parameters:
newTopPosition
- the new value for TopPosition.- Throws:
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:
ObjectDeletedException
- If this method is called when the object has been marked for deletion.ObjectNotAttachedToSessionException
- If this method is called when the object has been removed from it's session.
-
getQueue
Queue getQueue()
Get the Queue.- Returns:
- Queue
- Throws:
ObjectDeletedException
- If this method is called when the object has been marked for deletion.ObjectNotAttachedToSessionException
- If this method is called when the object has been removed from it's session.
-
setQueue
void setQueue(Queue newQueue)
Set the value for Queue. This value is mandatory.- Parameters:
newQueue
- is the object to set Queue to. The queue If this isnull
, then the object cannot be persisted.
-
-