Class DataCollectionObject

    • Constructor Detail

      • DataCollectionObject

        protected DataCollectionObject​(DataCollectionConfiguration owner,
                                       org.netxms.base.NXCPMessage msg)
        Create data collection object from NXCP message
        Parameters:
        owner - Owning configuration object
        msg - NXCP message
      • DataCollectionObject

        protected DataCollectionObject​(DataCollectionConfiguration owner,
                                       long id)
        Constructor for new data collection objects.
        Parameters:
        owner - Owning configuration object
        id - Identifier assigned to new item
    • Method Detail

      • fillMessage

        public void fillMessage​(org.netxms.base.NXCPMessage msg)
        Fill NXCP message with item's data.
        Parameters:
        msg - NXCP message
      • getTemplateId

        public long getTemplateId()
        Returns:
        the templateId
      • setTemplateId

        public void setTemplateId​(long templateId)
        Parameters:
        templateId - the templateId to set
      • getResourceId

        public long getResourceId()
        Returns:
        the resourceId
      • setResourceId

        public void setResourceId​(long resourceId)
        Parameters:
        resourceId - the resourceId to set
      • getSourceNode

        public long getSourceNode()
        Get source node (node where actual data collection took place) ID
        Returns:
        source node ID (0 if not set)
      • setSourceNode

        public void setSourceNode​(long sourceNode)
        Set source node (node where actual data collection took place) ID. Set to 0 to use DCI's owning node.
        Parameters:
        sourceNode - source node ID
      • getPollingInterval

        public String getPollingInterval()
        Returns:
        the pollingInterval
      • getComparablePollingInterval

        public int getComparablePollingInterval()
        Returns:
        polling interval suitable for sorting
      • setPollingInterval

        public void setPollingInterval​(String pollingInterval)
        Parameters:
        pollingInterval - the pollingInterval to set
      • getPollingScheduleType

        public int getPollingScheduleType()
        Returns:
        the pollingScheduleType
      • setPollingScheduleType

        public void setPollingScheduleType​(int pollingScheduleType)
        Parameters:
        pollingScheduleType - the pollingScheduleType to set
      • getRetentionTime

        public String getRetentionTime()
        Returns:
        the retentionTime
      • getComparableRetentionTime

        public int getComparableRetentionTime()
        Returns:
        The retention time
      • setRetentionTime

        public void setRetentionTime​(String retentionTime)
        Parameters:
        retentionTime - the retentionTime to set
      • getRetentionType

        public int getRetentionType()
        Returns:
        the retentionType
      • setRetentionType

        public void setRetentionType​(int retentionType)
        Parameters:
        retentionType - the retentionType to set
      • getOrigin

        public int getOrigin()
        Returns:
        the origin
      • setOrigin

        public void setOrigin​(int origin)
        Parameters:
        origin - the origin to set
      • getStatus

        public int getStatus()
        Returns:
        the status
      • setStatus

        public void setStatus​(int status)
        Parameters:
        status - the status to set
      • isUseAdvancedSchedule

        public boolean isUseAdvancedSchedule()
        Returns:
        the useAdvancedSchedule
      • getName

        public String getName()
        Returns:
        the name
      • setName

        public void setName​(String name)
        Parameters:
        name - the name to set
      • getDescription

        public String getDescription()
        Returns:
        the description
      • setDescription

        public void setDescription​(String description)
        Parameters:
        description - the description to set
      • getId

        public long getId()
        Returns:
        the id
      • getSchedules

        public ArrayList<String> getSchedules()
        Returns:
        the schedules
      • setSchedules

        public void setSchedules​(Collection<String> newSchedules)
        Set schedules
        Parameters:
        newSchedules - Collection containing new schedules
      • getNodeId

        public long getNodeId()
        Get ID of owning node.
        Returns:
        id of owning node
      • getSystemTag

        public String getSystemTag()
        Get system tag. In most situations, system tag should not be shown to user.
        Returns:
        System tag associated with this DCI
      • setSystemTag

        public void setSystemTag​(String systemTag)
        Set system tag. In most situations, user should not have possibility to set system tag manually.
        Parameters:
        systemTag - New system tag for DCI
      • getPerfTabSettings

        public String getPerfTabSettings()
        Returns:
        the perfTabSettings
      • setPerfTabSettings

        public void setPerfTabSettings​(String perfTabSettings)
        Parameters:
        perfTabSettings - the perfTabSettings to set
      • getSnmpPort

        public int getSnmpPort()
        Returns:
        the snmpPort
      • setSnmpPort

        public void setSnmpPort​(int snmpPort)
        Parameters:
        snmpPort - the snmpPort to set
      • getSnmpVersion

        public SnmpVersion getSnmpVersion()
        Returns:
        the snmpVersion
      • setSnmpVersion

        public void setSnmpVersion​(SnmpVersion snmpVersion)
        Parameters:
        snmpVersion - the snmpVersion to set
      • getFlags

        public int getFlags()
        Returns:
        the flags
      • setFlags

        public void setFlags​(int flags)
        Parameters:
        flags - the flags to set
      • getTransformationScript

        public String getTransformationScript()
        Returns:
        the transformationScript
      • setTransformationScript

        public void setTransformationScript​(String transformationScript)
        Parameters:
        transformationScript - the transformationScript to set
      • getUserData

        public Object getUserData()
        Returns:
        the userData
      • setUserData

        public void setUserData​(Object userData)
        Parameters:
        userData - the userData to set
      • isAggregateOnCluster

        public boolean isAggregateOnCluster()
        Returns:
        the processAllThresholds
      • setAggregateOnCluster

        public void setAggregateOnCluster​(boolean enable)
      • isAggregateWithErrors

        public boolean isAggregateWithErrors()
        Include node DCI value into aggregated value even in case of data collection error (system will use last known value in that case)
        Returns:
        true if enabled
      • setAggregateWithErrors

        public void setAggregateWithErrors​(boolean enable)
        Enable or disable inclusion of node DCI value into aggregated value even in case of data collection error (system will use last known value in that case)
        Parameters:
        enable - true to enable
      • isTransformAggregated

        public boolean isTransformAggregated()
      • setTransformAggregated

        public void setTransformAggregated​(boolean enable)
      • getComments

        public String getComments()
        Returns:
        the comments
      • setComments

        public void setComments​(String comments)
        Parameters:
        comments - the comments to set
      • getCacheMode

        public AgentCacheMode getCacheMode()
        Returns:
        aggregation function
      • isNewItem

        public boolean isNewItem()
      • setId

        public void setId​(long id)
      • getInstance

        public String getInstance()
        Returns:
        the instance
      • setInstance

        public void setInstance​(String instance)
        Parameters:
        instance - the instance to set
      • getInstanceDiscoveryMethod

        public final int getInstanceDiscoveryMethod()
        Returns:
        the instanceDiscoveryMethod
      • setInstanceDiscoveryMethod

        public final void setInstanceDiscoveryMethod​(int instanceDiscoveryMethod)
        Parameters:
        instanceDiscoveryMethod - the instanceDiscoveryMethod to set
      • getInstanceDiscoveryData

        public final String getInstanceDiscoveryData()
        Returns:
        the instanceDiscoveryData
      • setInstanceDiscoveryData

        public final void setInstanceDiscoveryData​(String instanceDiscoveryData)
        Parameters:
        instanceDiscoveryData - the instanceDiscoveryData to set
      • getInstanceDiscoveryFilter

        public final String getInstanceDiscoveryFilter()
        Returns:
        the instanceDiscoveryFilter
      • setInstanceDiscoveryFilter

        public final void setInstanceDiscoveryFilter​(String instanceDiscoveryFilter)
        Parameters:
        instanceDiscoveryFilter - the instanceDiscoveryFilter to set
      • getAccessList

        public List<Long> getAccessList()
        Get data collection object access list
        Returns:
        access list
      • setAccessList

        public void setAccessList​(List<Long> list)
        Set data collection object access list
        Parameters:
        list - new access list
      • getInstanceRetentionTime

        public int getInstanceRetentionTime()
        Get instance retention time
        Returns:
        instance retention time
      • setInstanceRetentionTime

        public void setInstanceRetentionTime​(int instanceRetentionTime)
        Set instance retention time
        Parameters:
        instanceRetentionTime - the retention time to set
      • isHideOnLastValuesView

        public boolean isHideOnLastValuesView()
        Returns if dco is hidden on Last Values view
        Returns:
        if dco should be hidden on Last Values view
      • setHideOnLastValuesView

        public void setHideOnLastValuesView​(boolean enable)
        Enable or disable usage of this DCI for node status calculation
        Parameters:
        enable - true to enable
      • getRelatedObject

        public long getRelatedObject()
        Returns:
        the relatedObject
      • setRelatedObject

        public void setRelatedObject​(long relatedObject)
        Parameters:
        relatedObject - the relatedObject to set