Package com.redwood.scheduler.api.model
Interface Dashboard
-
- All Superinterfaces:
ApplicationObject
,BusinessKeyObject
,DashboardComp
,HasOwner
,NamedRootObject
,NamedRootObjectComp
,PartitionableObject
,PartitionableObjectComp
,Root
,SchedulerEntity
,SchedulerEntityComp
public interface Dashboard extends DashboardComp, ApplicationObject, HasOwner, BusinessKeyObject
Defines the layout for a dashboard page A dashboard defines the layout and content for a dashboard page. A dashboard page consists of dashboarditems.
-
-
Field Summary
Fields Modifier and Type Field Description static String
OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "Dashboard" 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 , deletestatic String
SEC_RANK_CREATE
This rank is made of the following privileges: createstatic String
SEC_RANK_DELETE
This rank is made of the following privileges: create , view , deletestatic String
SEC_RANK_EDIT
This rank is made of the following privileges: create , view , editstatic 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: viewstatic QueryObjectType<Dashboard>
TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)
.static com.redwood.scheduler.infrastructure.logging.Versions
VERSION_DASHBOARD
-
Fields inherited from interface com.redwood.scheduler.api.model.ApplicationObject
VERSION_APPLICATIONOBJECT
-
Fields inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
COPYRIGHT_MESSAGE_BKO, ID_BKO
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.DashboardComp
VERSION_DASHBOARDCOMP
-
Fields inherited from interface com.redwood.scheduler.api.model.HasOwner
OWNER_SUBJECT_FIELD
-
Fields inherited from interface com.redwood.scheduler.api.model.NamedRootObject
VERSION_NAMEDROOTOBJECT
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.NamedRootObjectComp
VERSION_NAMEDROOTOBJECTCOMP
-
Fields inherited from interface com.redwood.scheduler.api.model.PartitionableObject
VERSION_PARTITIONABLEOBJECT
-
Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.PartitionableObjectComp
VERSION_PARTITIONABLEOBJECTCOMP
-
Fields inherited from interface com.redwood.scheduler.api.model.Root
VERSION_ROOT
-
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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.DashboardItem
createDashboardItem()
Create a newDashboardItem
linked to this object.RWIterable<DashboardItem>
getDashboarditems()
Get anRWIterable
over a collection ofDashboarditems
, the collection will be ordered by UniqueId.Subject
getOwnerSubject()
Get the OwnerSubject.Long
getUpdateTime()
Get the value for UpdateTime.void
setOwnerSubject(Subject newOwnerSubject)
Set the value for OwnerSubject.void
setUpdateTime(Long newUpdateTime)
Set the value for UpdateTime.-
Methods inherited from interface com.redwood.scheduler.api.model.ApplicationObject
getParentApplication, setParentApplication
-
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.PartitionableObject
createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition
-
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
-
-
-
-
Field Detail
-
VERSION_DASHBOARD
static final com.redwood.scheduler.infrastructure.logging.Versions VERSION_DASHBOARD
-
OBJECT_TYPE
static final String OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()
for "Dashboard" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<Dashboard> TYPE
Type that can be used inSchedulerSession.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
-
getUpdateTime
Long getUpdateTime()
Get the value for UpdateTime. (How often will the dashboard be updated.) This value is mandatory, and therefore will not benull
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.
-
setUpdateTime
void setUpdateTime(Long newUpdateTime)
Set the value for UpdateTime. (How often will the dashboard be updated.) This value is mandatory.- Parameters:
newUpdateTime
- the new value for UpdateTime. If this isnull
, 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 interfaceHasOwner
- 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 Dashboard If this isnull
, then the object cannot be persisted.
-
getDashboarditems
RWIterable<DashboardItem> getDashboarditems()
Get anRWIterable
over a collection ofDashboarditems
, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull
. Dashboard items that are visible on the dashboard.- Specified by:
getDashboarditems
in interfaceDashboardComp
- Returns:
- An
RWIterable
over a collection ofDashboardItem
objects , the collection will be ordered by UniqueId.
-
createDashboardItem
DashboardItem createDashboardItem()
Create a newDashboardItem
linked to this object.- Returns:
- a new
DashboardItem
.
-
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.
-
-