Package org.netxms.client.objects

Class Facility

java.lang.Object

org.netxms.client.objects.AbstractObject

org.netxms.client.objects.GenericObject

org.netxms.client.objects.DataCollectionTarget

org.netxms.client.objects.DataCollectionContainer

org.netxms.client.objects.Facility

All Implemented Interfaces:

AutoBindObject, PollingTarget

public class Facility
extends DataCollectionContainer

Facility object - reporting boundary for data center energy monitoring

Field Summary

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

DCF_DISABLE_CONF_POLL, DCF_DISABLE_DATA_COLLECT, DCF_DISABLE_STATUS_POLL, DCF_LOCATION_CHANGE_EVENT, DCSF_NETWORK_PATH_PROBLEM, DCSF_UNREACHABLE, geoAreas, geoLocationControlMode, numDataCollectionItems, overviewDciData, tooltipDciData, webServiceProxyId

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

accessList, aiHint, 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, isHidden, maintenanceInitiatorId, maintenanceScheduled, 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_CLOUDDOMAIN, OBJECT_CLUSTER, OBJECT_COLLECTOR, OBJECT_CONDITION, OBJECT_CONTAINER, OBJECT_COOLINGZONE, OBJECT_CUSTOM, OBJECT_DASHBOARD, OBJECT_DASHBOARDGROUP, OBJECT_DASHBOARDROOT, OBJECT_DASHBOARDTEMPLATE, OBJECT_FACILITY, OBJECT_GENERIC, OBJECT_INTERFACE, OBJECT_MOBILEDEVICE, OBJECT_NETWORK, OBJECT_NETWORKMAP, OBJECT_NETWORKMAPGROUP, OBJECT_NETWORKMAPROOT, OBJECT_NETWORKSERVICE, OBJECT_NODE, OBJECT_OBSERVATIONPOINT, OBJECT_POWERDOMAIN, OBJECT_RACK, OBJECT_RESOURCE, OBJECT_SENSOR, OBJECT_SERVICEROOT, OBJECT_SUBNET, OBJECT_TEMPLATE, OBJECT_TEMPLATEGROUP, OBJECT_TEMPLATEROOT, OBJECT_TRAFFICOBSERVER, OBJECT_VPNCONNECTOR, OBJECT_WIRELESSDOMAIN, OBJECT_ZONE, objectClass, objectId, objectName, parents, partialObject, pollStates, portStopList, 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
Facility(NXCPMessage msg, NXCSession session)	Create from NXCP message.

Method Summary

Modifier and Type	Method	Description
String	getObjectClassName()	Get name of NetXMS object's class.
String	getProviderId()	Get selected KPI computation provider ID.
int	getSettlementLag()	Get settlement lag (number of days a provisional day waits before settlement).
Set<String>	getStrings()	Get all strings in object
boolean	isEngineEnabled()	Check if KPI computation engine is enabled for this facility (computation provider is selected).

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

canHaveAgent, canHaveInterfaces, canHavePollerNode, canUseEtherNetIP, canUseModbus, getAgentCacheMode, getAutoBindFilter, getAutoBindFlags, getFlags, getIfXTablePolicy, getPollerNodeId, getPollStates, isAlarmsVisible, isAllowedOnMap, isAutoBindEnabled, isAutoUnbindEnabled

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

getGeoAreas, getGeoLocationControlMode, getNumDataCollectionItems, getOverviewDciData, getTooltipDciData, getWebServiceProxyId, isEventSource, isLocationChageEventGenerated

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

addString, areChildrenSynchronized, getAccessList, getAiHint, 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, getPortStopList, getPostalAddress, getPrimaryZoneProxyId, getResponsibleUsers, getStatus, getStatusCalculationMethod, getStatusPropagationMethod, getStatusShift, getStatusSingleThreshold, getStatusThresholds, getStatusTransformation, getTrustedObjects, getUrls, hasAccessibleChildren, hasAccessibleParents, hasAccessibleViewParents, hasChildren, hasCustomAttribute, hasDashboard, hashCode, hasNetworkMap, hasParents, hasUrls, isChildOf, isChildOf, isDefaultImage, isDeleted, isDirectChildOf, isDirectParentOf, isHidden, isInheritAccessRights, isInMaintenanceMode, isMaintenanceScheduled, 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

Facility

public Facility(NXCPMessage msg,
 NXCSession session)

Create from NXCP message.

Parameters:

msg - NXCP message

session - owning client session

Method Details

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()

getSettlementLag

public int getSettlementLag()

Get settlement lag (number of days a provisional day waits before settlement).

Returns:

settlement lag in days

getProviderId

public String getProviderId()

Get selected KPI computation provider ID. Empty string means that engine is disabled for this facility.

Returns:

computation provider ID or empty string

isEngineEnabled

public boolean isEngineEnabled()

Check if KPI computation engine is enabled for this facility (computation provider is selected).

Returns:

true if engine is enabled

getStrings

public Set<String> getStrings()

Description copied from class: AbstractObject

Get all strings in object

Overrides:

getStrings in class DataCollectionContainer

Returns:

set of all strings in object

See Also:

• AbstractObject.getStrings()