Package com.redwood.scheduler.api.model

Interface VisualizationProcessServerQueue

All Superinterfaces:

BusinessKeyObject, HasOwner, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp, Visualization, VisualizationProcessServerQueueComp

public interface VisualizationProcessServerQueue
extends VisualizationProcessServerQueueComp, Visualization

The visualization of process servers and queues

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "VisualizationProcessServerQueue" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<VisualizationProcessServerQueue>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.HasOwner

OWNER_SUBJECT_FIELD

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
void	addAllProcessServers()	Add all missing process servers.
void	addAllQueues()	Add all missing queues.
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
VisualizationPSQProcessServer	createVisualizationPSQProcessServer()	Create a new VisualizationPSQProcessServer linked to this object.
VisualizationPSQQueue	createVisualizationPSQQueue()	Create a new VisualizationPSQQueue linked to this object.
VisualizationPSQText	createVisualizationPSQText()	Create a new VisualizationPSQText linked to this object.
Document	getBackgroundDocument()	Get the BackgroundDocument.
VisualizationPSQProcessServer	getVisualizationPSQProcessServerByProcessServer(ProcessServer processServer)	Get the VisualizationPSQProcessServer by ProcessServer.
RWIterable<VisualizationPSQProcessServer>	getVisualizationPSQProcessServers()	Get an RWIterable over an ordered collection of VisualizationPSQProcessServers.
VisualizationPSQQueue	getVisualizationPSQQueueByQueue(Queue queue)	Get the VisualizationPSQQueue by Queue.
RWIterable<VisualizationPSQQueue>	getVisualizationPSQQueues()	Get an RWIterable over an ordered collection of VisualizationPSQQueues.
RWIterable<VisualizationPSQText>	getVisualizationPSQTexts()	Get an RWIterable over an ordered collection of VisualizationPSQTexts.
void	setBackgroundDocument(Document newBackgroundDocument)	Set the value for BackgroundDocument.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.Root

getCreationTime, getLastModificationTime, getLastModifierSubject

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

Methods inherited from interface com.redwood.scheduler.api.model.Visualization

getAnimationTime, getDefaultFontSize, getLogCategories, getOwnerSubject, isAnimated, setAnimated, setAnimationTime, setDefaultFontSize, setLogCategories, setOwnerSubject

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "VisualizationProcessServerQueue" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<VisualizationProcessServerQueue> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

addAllProcessServers

void addAllProcessServers()

Add all missing process servers.

addAllQueues

void addAllQueues()

Add all missing queues.

getBackgroundDocument

Document getBackgroundDocument()

Get the BackgroundDocument.

Returns:

BackgroundDocument

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.

setBackgroundDocument

void setBackgroundDocument(Document newBackgroundDocument)

Set the value for BackgroundDocument. This value is optional.

Parameters:

newBackgroundDocument - is the object to set BackgroundDocument to. The process servers to show in the process server and queue visualization

getVisualizationPSQProcessServers

RWIterable<VisualizationPSQProcessServer> getVisualizationPSQProcessServers()

Get an RWIterable over an ordered collection of VisualizationPSQProcessServers. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The process servers to show in the process server and queue visualization

Specified by:

getVisualizationPSQProcessServers in interface VisualizationProcessServerQueueComp

Returns:

An RWIterable over an ordered collection of VisualizationPSQProcessServer objects .

createVisualizationPSQProcessServer

VisualizationPSQProcessServer createVisualizationPSQProcessServer()

Create a new VisualizationPSQProcessServer linked to this object.

Returns:

a new VisualizationPSQProcessServer.

getVisualizationPSQProcessServerByProcessServer

VisualizationPSQProcessServer getVisualizationPSQProcessServerByProcessServer(ProcessServer processServer)

Get the VisualizationPSQProcessServer by ProcessServer.

Parameters:

processServer -

Returns:

the VisualizationPSQProcessServer, or null if it could not be found

getVisualizationPSQQueues

RWIterable<VisualizationPSQQueue> getVisualizationPSQQueues()

Get an RWIterable over an ordered collection of VisualizationPSQQueues. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The queues to show in the process server and queue visualization

Specified by:

getVisualizationPSQQueues in interface VisualizationProcessServerQueueComp

Returns:

An RWIterable over an ordered collection of VisualizationPSQQueue objects .

createVisualizationPSQQueue

VisualizationPSQQueue createVisualizationPSQQueue()

Create a new VisualizationPSQQueue linked to this object.

Returns:

a new VisualizationPSQQueue.

getVisualizationPSQQueueByQueue

VisualizationPSQQueue getVisualizationPSQQueueByQueue(Queue queue)

Get the VisualizationPSQQueue by Queue.

Parameters:

queue -

Returns:

the VisualizationPSQQueue, or null if it could not be found

getVisualizationPSQTexts

RWIterable<VisualizationPSQText> getVisualizationPSQTexts()

Get an RWIterable over an ordered collection of VisualizationPSQTexts. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The text notes to show in the process server and queue visualization

Specified by:

getVisualizationPSQTexts in interface VisualizationProcessServerQueueComp

Returns:

An RWIterable over an ordered collection of VisualizationPSQText objects .

createVisualizationPSQText

VisualizationPSQText createVisualizationPSQText()

Create a new VisualizationPSQText linked to this object.

Returns:

a new VisualizationPSQText.

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.