Package org.netxms.client.objects

Class Dashboard

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DashboardBase

org.netxms.client.objects.Dashboard

All Implemented Interfaces:

AutoBindObject, PollingTarget

public class Dashboard
extends DashboardBase

Dashboard object

Field Summary

Fields inherited from class org.netxms.client.objects.DashboardBase

SCROLLABLE, SHOW_AS_OBJECT_VIEW, SHOW_CONTEXT_SELECTOR

Fields inherited from class org.netxms.client.objects.AbstractObject

accessList, alias, assetId, ASSETS, backupZoneProxyId, BUSINESSSERVICEROOT, CALCULATE_DEFAULT, CALCULATE_MOST_CRITICAL, CALCULATE_MULTIPLE_THRESHOLDS, CALCULATE_SINGLE_THRESHOLD, categoryId, children, comments, commentsSource, CONTEXT, creationTime, customAttributes, DASHBOARDROOT, dashboards, drillDownObjectId, fixedPropagatedStatus, flags, geolocation, guid, inheritAccessRights, inMaintenanceMode, isDeleted, maintenanceInitiatorId, mapImage, MARKDOWN_COMMENTS_INDICATOR, moduleData, nameOnMap, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_ASSET, OBJECT_ASSETGROUP, OBJECT_ASSETROOT, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEPROTOTYPE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CHASSIS, OBJECT_CIRCUIT, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, OBJECT_DASHBOARDTEMPLATE, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_RACK, OBJECT_SENSOR, OBJECT_SERVICEROOT, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_VPNCONNECTOR, OBJECT_WIRELESSDOMAIN, OBJECT_ZONE, objectClass, objectId, objectName, parents, partialObject, pollStates, postalAddress, primaryZoneProxyId, PROPAGATE_DEFAULT, PROPAGATE_FIXED, PROPAGATE_RELATIVE, PROPAGATE_TRANSLATED, PROPAGATE_UNCHANGED, responsibleUsers, SERVICEROOT, session, status, statusCalculationMethod, statusPropagationMethod, statusShift, statusSingleThreshold, statusThresholds, statusTransformation, TEMPLATEROOT, trustedObjects, UNKNOWN, urls, ZONE0

Fields inherited from interface org.netxms.client.objects.interfaces.AutoBindObject

OBJECT_BIND_FLAG, OBJECT_UNBIND_FLAG

Constructor Summary

Constructors

Constructor	Description
Dashboard(NXCPMessage msg, NXCSession session)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
int	getDisplayPriority()	Get dashboard's display priority if it should be shown as object view.
long	getForcedContextObjectId()	Get forced context object ID.
String	getObjectClassName()	Get name of NetXMS object's class.
boolean	isTemplateInstance()	Check if this dashboard is instance of template (has forced context object).

Methods inherited from class org.netxms.client.objects.DashboardBase

canHaveAgent, canHaveInterfaces, canHavePollerNode, canUseEtherNetIP, canUseModbus, getAgentCacheMode, getAutoBindFilter, getAutoBindFlags, getElements, getFlags, getIfXTablePolicy, getNumColumns, getPollerNodeId, getPollStates, isAutoBindEnabled, isAutoUnbindEnabled, isScrollable, isShowContentSelector

Methods inherited from class org.netxms.client.objects.AbstractObject

addString, areChildrenSynchronized, getAccessList, getAlias, getAllChildren, getAllChildren, getAllParents, getAllParents, getAssetId, getBackupZoneProxyId, getCategory, getCategoryId, getChildCount, getChildIdList, getChildren, getChildrenAsArray, getComments, getCommentsSource, getConfiguredNameOnMap, getCreationTime, getCustomAttribute, getCustomAttributes, getCustomAttributeValue, getCustomAttributeValueAsBoolean, getDashboardIdentifiers, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getNetworkMaps, getObjectClass, getObjectId, getObjectName, getObjectNameWithPath, getParentChain, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getStrings, getTrustedObjects, getUrls, hasAccessibleChildren, hasAccessibleParents, hasAccessibleViewParents, hasChildren, hasCustomAttribute, hasDashboard, hashCode, hasNetworkMap, hasParents, hasUrls, isAlarmsVisible, isAllowedOnMap, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isDirectParentOf, isInheritAccessRights, isInMaintenanceMode, isParentOf, isParentOf, isPartialObject, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.netxms.client.objects.interfaces.PollingTarget

getObjectId, getObjectName

Constructor Details

Dashboard

public Dashboard(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - owning client session

Method Details

getDisplayPriority

public int getDisplayPriority()

Get dashboard's display priority if it should be shown as object view.

Returns:

dashboard's display priority

getForcedContextObjectId

public long getForcedContextObjectId()

Get forced context object ID.

Returns:

forced context object ID or 0 if none

getObjectClassName

public String getObjectClassName()

Description copied from class: AbstractObject

Get name of NetXMS object's class.

Overrides:

getObjectClassName in class AbstractObject

Returns:

Name of NetXMS object's class

See Also:

• AbstractObject.getObjectClassName()

isTemplateInstance

public boolean isTemplateInstance()

Check if this dashboard is instance of template (has forced context object).

Returns:

true if this dashboard is instance of template