Package com.redwood.scheduler.api.model

Interface Visualization

All Superinterfaces:

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

All Known Subinterfaces:

VisualizationAlert, VisualizationProcessServerQueue

public interface Visualization
extends NamedRootObject, HasOwner, BusinessKeyObject

Abstract base class for visualizations using applets A Visualization defines user settings and content for an applet visualization.

Field Summary

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

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
Long	getAnimationTime()	Get the value for AnimationTime.
Long	getDefaultFontSize()	Get the value for DefaultFontSize.
String	getLogCategories()	Get the value for LogCategories.
Subject	getOwnerSubject()	Get the OwnerSubject.
boolean	isAnimated()	Get the value for Animated.
void	setAnimated(boolean newAnimated)	Set the value for Animated.
void	setAnimationTime(Long newAnimationTime)	Set the value for AnimationTime.
void	setDefaultFontSize(Long newDefaultFontSize)	Set the value for DefaultFontSize.
void	setLogCategories(String newLogCategories)	Set the value for LogCategories.
void	setOwnerSubject(Subject newOwnerSubject)	Set the value for OwnerSubject.

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

Method Detail

isAnimated

boolean isAnimated()

Get the value for Animated. (Use animations 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.

getAnimationTime

Long getAnimationTime()

Get the value for AnimationTime. (The duration in milliseconds of animations in the visualization.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getDefaultFontSize

Long getDefaultFontSize()

Get the value for DefaultFontSize. (The default font size in points.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getLogCategories

String getLogCategories()

Get the value for LogCategories. (The logger categories to enable on the client.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setAnimated

void setAnimated(boolean newAnimated)

Set the value for Animated. (Use animations in the visualization.)

Parameters:

newAnimated - the new value for Animated.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setAnimationTime

void setAnimationTime(Long newAnimationTime)

Set the value for AnimationTime. (The duration in milliseconds of animations in the visualization.) This value is mandatory.

Parameters:

newAnimationTime - the new value for AnimationTime. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setDefaultFontSize

void setDefaultFontSize(Long newDefaultFontSize)

Set the value for DefaultFontSize. (The default font size in points.) This value is mandatory.

Parameters:

newDefaultFontSize - the new value for DefaultFontSize. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setLogCategories

void setLogCategories(String newLogCategories)

Set the value for LogCategories. (The logger categories to enable on the client.) This value is mandatory.

Parameters:

newLogCategories - the new value for LogCategories. If this is null, then the object cannot be persisted.

Throws:

ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getOwnerSubject

Subject getOwnerSubject()

Get the OwnerSubject.

Specified by:

getOwnerSubject in interface HasOwner

Returns:

OwnerSubject

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.

setOwnerSubject

void setOwnerSubject(Subject newOwnerSubject)

Set the value for OwnerSubject. This value is mandatory.

Parameters:

newOwnerSubject - is the object to set OwnerSubject to. Who Created this Visualization If this is null, then the object cannot be persisted.