Package org.netxms.client.objects

Class DashboardBase

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DashboardBase

All Implemented Interfaces:

AutoBindObject, PollingTarget

Direct Known Subclasses:

Dashboard, DashboardTemplate

public class DashboardBase
extends GenericObject
implements AutoBindObject, PollingTarget

Base interface for dashboard objects

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SCROLLABLE
static final int	SHOW_AS_OBJECT_VIEW
static final int	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
DashboardBase(NXCPMessage msg, NXCSession session)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
boolean	canHaveAgent()	Identify if this object can have NetXMS agent.
boolean	canHaveInterfaces()	Identify if this object can have network interfaces.
boolean	canHavePollerNode()	Identify if this object can have poller node property.
boolean	canUseEtherNetIP()	Identify if this object can use EtherNet/IP for communications.
boolean	canUseModbus()	Identify if this object can use Modbus for communications.
AgentCacheMode	getAgentCacheMode()	Get agent cache mode.
String	getAutoBindFilter()
int	getAutoBindFlags()
List<DashboardElement>	getElements()
int	getFlags()	Get object flags.
int	getIfXTablePolicy()	Get ifXTable usage policy.
int	getNumColumns()
long	getPollerNodeId()	Get poller node ID.
PollState[]	getPollStates()	Get poll states.
boolean	isAutoBindEnabled()
boolean	isAutoUnbindEnabled()
boolean	isScrollable()	Check if "scrollable" flag is set for this dashboard.
boolean	isShowContentSelector()	Check if "show as object view" 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, getDashboardIdentifiers, getDashboards, getDrillDownObjectId, getEffectiveRights, getFixedPropagatedStatus, getGeolocation, getGuid, getIcon, getMaintenanceInitiatorId, getMapImage, getModuleData, getNameOnMap, getNameWithAlias, getNetworkMaps, getObjectClass, getObjectClassName, 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

Field Details

SHOW_AS_OBJECT_VIEW

public static final int SHOW_AS_OBJECT_VIEW

See Also:

• Constant Field Values

SCROLLABLE

public static final int SCROLLABLE

See Also:

• Constant Field Values

SHOW_CONTEXT_SELECTOR

public static final int SHOW_CONTEXT_SELECTOR

See Also:

• Constant Field Values

Constructor Details

DashboardBase

public DashboardBase(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - 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

isShowContentSelector

public boolean isShowContentSelector()

Check if "show as object view" flag is set for this dashboard.

Returns:

true if "show as object view" flag is set for this dashboard

getElements

public List<DashboardElement> getElements()

Returns:

the elements

isAutoBindEnabled

public boolean isAutoBindEnabled()

Specified by:

isAutoBindEnabled in interface AutoBindObject

Returns:

true if automatic bind is enabled

See Also:

• AutoBindObject.isAutoBindEnabled()

isAutoUnbindEnabled

public boolean isAutoUnbindEnabled()

Specified by:

isAutoUnbindEnabled in interface AutoBindObject

Returns:

true if automatic unbind is enabled

See Also:

• AutoBindObject.isAutoUnbindEnabled()

getAutoBindFilter

public String getAutoBindFilter()

Specified by:

getAutoBindFilter in interface AutoBindObject

Returns:

Filter script for automatic bind

See Also:

• AutoBindObject.getAutoBindFilter()

getAutoBindFlags

public int getAutoBindFlags()

Specified by:

getAutoBindFlags in interface AutoBindObject

Returns:

auto bind flags

See Also:

• AutoBindObject.getAutoBindFlags()

getFlags

public int getFlags()

Description copied from interface: PollingTarget

Get object flags.

Specified by:

getFlags in interface PollingTarget

Returns:

object flags

See Also:

• PollingTarget.getFlags()

getIfXTablePolicy

public int getIfXTablePolicy()

Description copied from interface: PollingTarget

Get ifXTable usage policy.

Specified by:

getIfXTablePolicy in interface PollingTarget

Returns:

ifXTable usage policy

See Also:

• PollingTarget.getIfXTablePolicy()

getAgentCacheMode

public AgentCacheMode getAgentCacheMode()

Description copied from interface: PollingTarget

Get agent cache mode.

Specified by:

getAgentCacheMode in interface PollingTarget

Returns:

agent cache mode

See Also:

• PollingTarget.getAgentCacheMode()

getPollerNodeId

public long getPollerNodeId()

Description copied from interface: PollingTarget

Get poller node ID.

Specified by:

getPollerNodeId in interface PollingTarget

Returns:

poller node ID or 0 if object cannot have poler node

See Also:

• PollingTarget.getPollerNodeId()

canHaveAgent

public boolean canHaveAgent()

Description copied from interface: PollingTarget

Identify if this object can have NetXMS agent.

Specified by:

canHaveAgent in interface PollingTarget

Returns:

true if this object can have NetXMS agent

See Also:

• PollingTarget.canHaveAgent()

canHaveInterfaces

public boolean canHaveInterfaces()

Description copied from interface: PollingTarget

Identify if this object can have network interfaces.

Specified by:

canHaveInterfaces in interface PollingTarget

Returns:

true if this object can have network interfaces

See Also:

• PollingTarget.canHaveInterfaces()

canHavePollerNode

public boolean canHavePollerNode()

Description copied from interface: PollingTarget

Identify if this object can have poller node property.

Specified by:

canHavePollerNode in interface PollingTarget

Returns:

true if this object can have poller node property

See Also:

• PollingTarget.canHavePollerNode()

canUseEtherNetIP

public boolean canUseEtherNetIP()

Description copied from interface: PollingTarget

Identify if this object can use EtherNet/IP for communications.

Specified by:

canUseEtherNetIP in interface PollingTarget

Returns:

true if this object can use EtherNet/IP for communications

See Also:

• PollingTarget.canUseEtherNetIP()

canUseModbus

public boolean canUseModbus()

Description copied from interface: PollingTarget

Identify if this object can use Modbus for communications.

Specified by:

canUseModbus in interface PollingTarget

Returns:

true if this object can use Modbus for communications

See Also:

• PollingTarget.canUseModbus()

getPollStates

public PollState[] getPollStates()

Description copied from interface: PollingTarget

Get poll states.

Specified by:

getPollStates in interface PollingTarget

Returns:

array of poll states or null if object doesn't have any

See Also:

• PollingTarget.getPollStates()