Package com.redwood.scheduler.api.model

Interface DashboardItem

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

public interface DashboardItem
extends Detail

An item that is visible on the DashBoard A DashboardWidget is an item that is visible on the Dashboard.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "DashboardItem" 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<DashboardItem>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static com.redwood.scheduler.infrastructure.logging.Versions	VERSION_DASHBOARDITEM

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

VERSION_DETAIL

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

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
Dashboard	getDashboard()	Get the Dashboard.
String	getFullConfiguration()	Get the value for FullConfiguration.
Long	getNumAdditionalLines()	Get the value for NumAdditionalLines.
void	setFullConfiguration(String newFullConfiguration)	Set the value for FullConfiguration.

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

VERSION_DASHBOARDITEM

static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_DASHBOARDITEM

OBJECT_TYPE

static final String OBJECT_TYPE

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

See Also:

Constant Field Values

TYPE

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

getFullConfiguration

String getFullConfiguration()

Get the value for FullConfiguration. (The full configuration of the widget. This is a property file.) 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.

getNumAdditionalLines

Long getNumAdditionalLines()

Get the value for NumAdditionalLines. (The number of additional lines for the configuration.) 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.

setFullConfiguration

void setFullConfiguration(String newFullConfiguration)

Set the value for FullConfiguration. (The full configuration of the widget. This is a property file.) This value is mandatory.

Parameters:

newFullConfiguration - the new value for FullConfiguration. 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.

getDashboard

Dashboard getDashboard()

Get the Dashboard.

Returns:

Dashboard

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.