org.netxms.client.datacollection
Class DataCollectionConfiguration

java.lang.Object
  extended by org.netxms.client.datacollection.DataCollectionConfiguration

public class DataCollectionConfiguration
extends java.lang.Object

Data collection configuration for node

Author:
Victor Kirhenshtein

Constructor Summary
DataCollectionConfiguration(NXCSession session, long nodeId)
          Create empty data collection configuration.
 
Method Summary
 void clearCollectedData(long itemId)
          Clear collected data for given DCI.
 void close()
          Close data collection configuration.
 void copyItems(long destNodeId, long[] items)
          Copy data collection items.
 long createItem()
          Create new data collection item.
 void deleteItem(long itemId)
          Delete data collection item.
protected  void finalize()
           
 DataCollectionItem findItem(long id)
          Find data collection item by ID.
 DataCollectionItem[] getItems()
          Get list of data collection items
 long getNodeId()
           
 java.lang.Object getUserData()
           
 void modifyItem(DataCollectionItem item)
          Modify data collection item.
 void modifyItem(long itemId)
          Modify data collection item.
 void moveItems(long destNodeId, long[] items)
          Move data collection items.
 void open()
          Open data collection configuration.
 void setItemStatus(long[] items, int status)
          Set status of data collection items.
 void setUserData(java.lang.Object userData)
           
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataCollectionConfiguration

public DataCollectionConfiguration(NXCSession session,
                                   long nodeId)
Create empty data collection configuration.

Parameters:
nodeId -
Method Detail

open

public void open()
          throws java.io.IOException,
                 NXCException
Open data collection configuration.

Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

close

public void close()
           throws java.io.IOException,
                  NXCException
Close data collection configuration.

Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

getItems

public DataCollectionItem[] getItems()
Get list of data collection items

Returns:
List of data collection items

findItem

public DataCollectionItem findItem(long id)
Find data collection item by ID.

Parameters:
id - DCI ID
Returns:
Data collection item or null if item with given ID does not exist

createItem

public long createItem()
                throws java.io.IOException,
                       NXCException
Create new data collection item.

Returns:
Identifier assigned to created item
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

modifyItem

public void modifyItem(long itemId)
                throws java.io.IOException,
                       NXCException
Modify data collection item.

Parameters:
itemId - Data collection item's identifier
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

modifyItem

public void modifyItem(DataCollectionItem item)
                throws java.io.IOException,
                       NXCException
Modify data collection item.

Parameters:
item - Data collection item
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

copyItems

public void copyItems(long destNodeId,
                      long[] items)
               throws java.io.IOException,
                      NXCException
Copy data collection items.

Parameters:
destNodeId - Destination node ID
items - List of data collection items to copy
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

moveItems

public void moveItems(long destNodeId,
                      long[] items)
               throws java.io.IOException,
                      NXCException
Move data collection items.

Parameters:
destNodeId - Destination node ID
items - List of data collection items to move
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

clearCollectedData

public void clearCollectedData(long itemId)
                        throws java.io.IOException,
                               NXCException
Clear collected data for given DCI.

Parameters:
itemId - Data collection item ID
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

setItemStatus

public void setItemStatus(long[] items,
                          int status)
                   throws java.io.IOException,
                          NXCException
Set status of data collection items.

Parameters:
items - Data collection items' identifiers
status - New status
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

deleteItem

public void deleteItem(long itemId)
                throws java.io.IOException,
                       NXCException
Delete data collection item.

Parameters:
itemId - Data collection item identifier
Throws:
java.io.IOException - if socket I/O error occurs
NXCException - if NetXMS server returns an error or operation was timed out

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

getNodeId

public long getNodeId()
Returns:
the nodeId

getUserData

public java.lang.Object getUserData()
Returns:
the userData

setUserData

public void setUserData(java.lang.Object userData)
Parameters:
userData - the userData to set


Copyright © 2011. All Rights Reserved.