Package org.netxms.client.objects
Class Dashboard
java.lang.Object
org.netxms.client.objects.AbstractObject
org.netxms.client.objects.GenericObject
org.netxms.client.objects.Dashboard
- All Implemented Interfaces:
AutoBindObject
,PollingTarget
Dashboard object
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
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, moduleData, nameOnMap, NETWORK, NETWORKMAPROOT, OBJECT_ACCESSPOINT, OBJECT_ASSET, OBJECT_ASSETGROUP, OBJECT_ASSETROOT, OBJECT_BUSINESSSERVICE, OBJECT_BUSINESSSERVICEPROTOTYPE, OBJECT_BUSINESSSERVICEROOT, OBJECT_CHASSIS, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, 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, urls, ZONE0
Fields inherited from interface org.netxms.client.objects.interfaces.AutoBindObject
OBJECT_BIND_FLAG, OBJECT_UNBIND_FLAG
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Identify if this object can have NetXMS agent.boolean
Identify if this object can have network interfaces.boolean
Identify if this object can have poller node property.boolean
Identify if this object can use EtherNet/IP for communications.boolean
Identify if this object can use Modbus for communications.Get agent cache mode.int
int
Get dashboard's display priority if it should be shown as object view.int
getFlags()
Get object flags.int
Get ifXTable usage policy.int
Get name of NetXMS object's class.long
Get poller node ID.Get poll states.boolean
boolean
boolean
Check if "scrollable" flag is set for this dashboard.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, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getObjectClass, getObjectId, getObjectName, getObjectNameWithPath, getParentChain, getParentCount, getParentIdList, getParents, getParentsAsArray, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getStrings, getTrustedObjects, getUrls, hasAccessibleChildren, hasChildren, hasCustomAttribute, hasDashboard, hashCode, 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
-
Field Details
-
SHOW_AS_OBJECT_VIEW
public static final int SHOW_AS_OBJECT_VIEW- See Also:
-
SCROLLABLE
public static final int SCROLLABLE- See Also:
-
-
Constructor Details
-
Dashboard
Create from NXCP message.- Parameters:
msg
- NXCP messagesession
- owning client session
-
-
Method Details
-
getNumColumns
public int getNumColumns()- Returns:
- the numColumns
-
isScrollable
public boolean isScrollable()Check if "scrollable" flag is set for this dashboard.- Returns:
- true if "scrollable" flag is set for this dashboard
-
getDisplayPriority
public int getDisplayPriority()Get dashboard's display priority if it should be shown as object view.- Returns:
- dashboard's display priority
-
getElements
- Returns:
- the elements
-
getObjectClassName
Description copied from class:AbstractObject
Get name of NetXMS object's class.- Overrides:
getObjectClassName
in classAbstractObject
- Returns:
- Name of NetXMS object's class
- See Also:
-
isAutoBindEnabled
public boolean isAutoBindEnabled()- Specified by:
isAutoBindEnabled
in interfaceAutoBindObject
- Returns:
- true if automatic bind is enabled
- See Also:
-
isAutoUnbindEnabled
public boolean isAutoUnbindEnabled()- Specified by:
isAutoUnbindEnabled
in interfaceAutoBindObject
- Returns:
- true if automatic unbind is enabled
- See Also:
-
getAutoBindFilter
- Specified by:
getAutoBindFilter
in interfaceAutoBindObject
- Returns:
- Filter script for automatic bind
- See Also:
-
getAutoBindFlags
public int getAutoBindFlags()- Specified by:
getAutoBindFlags
in interfaceAutoBindObject
- Returns:
- auto bind flags
- See Also:
-
getFlags
public int getFlags()Description copied from interface:PollingTarget
Get object flags.- Specified by:
getFlags
in interfacePollingTarget
- Returns:
- object flags
- See Also:
-
getIfXTablePolicy
public int getIfXTablePolicy()Description copied from interface:PollingTarget
Get ifXTable usage policy.- Specified by:
getIfXTablePolicy
in interfacePollingTarget
- Returns:
- ifXTable usage policy
- See Also:
-
getAgentCacheMode
Description copied from interface:PollingTarget
Get agent cache mode.- Specified by:
getAgentCacheMode
in interfacePollingTarget
- Returns:
- agent cache mode
- See Also:
-
getPollerNodeId
public long getPollerNodeId()Description copied from interface:PollingTarget
Get poller node ID.- Specified by:
getPollerNodeId
in interfacePollingTarget
- Returns:
- poller node ID or 0 if object cannot have poler node
- See Also:
-
canHaveAgent
public boolean canHaveAgent()Description copied from interface:PollingTarget
Identify if this object can have NetXMS agent.- Specified by:
canHaveAgent
in interfacePollingTarget
- Returns:
- true if this object can have NetXMS agent
- See Also:
-
canHaveInterfaces
public boolean canHaveInterfaces()Description copied from interface:PollingTarget
Identify if this object can have network interfaces.- Specified by:
canHaveInterfaces
in interfacePollingTarget
- Returns:
- true if this object can have network interfaces
- See Also:
-
canHavePollerNode
public boolean canHavePollerNode()Description copied from interface:PollingTarget
Identify if this object can have poller node property.- Specified by:
canHavePollerNode
in interfacePollingTarget
- Returns:
- true if this object can have poller node property
- See Also:
-
canUseEtherNetIP
public boolean canUseEtherNetIP()Description copied from interface:PollingTarget
Identify if this object can use EtherNet/IP for communications.- Specified by:
canUseEtherNetIP
in interfacePollingTarget
- Returns:
- true if this object can use EtherNet/IP for communications
- See Also:
-
canUseModbus
public boolean canUseModbus()Description copied from interface:PollingTarget
Identify if this object can use Modbus for communications.- Specified by:
canUseModbus
in interfacePollingTarget
- Returns:
- true if this object can use Modbus for communications
- See Also:
-
getPollStates
Description copied from interface:PollingTarget
Get poll states.- Specified by:
getPollStates
in interfacePollingTarget
- Returns:
- array of poll states or null if object doesn't have any
- See Also:
-