org.netxms.client.objecttools
Class ObjectTool

java.lang.Object
  extended by org.netxms.client.objecttools.ObjectTool
Direct Known Subclasses:
ObjectToolDetails

public class ObjectTool
extends java.lang.Object

NetXMS object tool representation


Field Summary
static int ASK_CONFIRMATION
           
protected  java.lang.String confirmationText
           
protected  java.lang.String data
           
protected  java.lang.String description
           
protected  java.lang.String displayName
           
protected  int flags
           
static int GENERATES_OUTPUT
           
protected  long id
           
protected  java.lang.String name
           
static int REQUIRES_AGENT
           
static int REQUIRES_OID_MATCH
           
static int REQUIRES_SNMP
           
static int SNMP_INDEXED_BY_VALUE
           
protected  java.lang.String snmpOid
           
protected  int type
           
static int TYPE_ACTION
           
static int TYPE_FILE_DOWNLOAD
           
static int TYPE_INTERNAL
           
static int TYPE_LOCAL_COMMAND
           
static int TYPE_SERVER_COMMAND
           
static int TYPE_TABLE_AGENT
           
static int TYPE_TABLE_SNMP
           
static int TYPE_URL
           
 
Constructor Summary
protected ObjectTool()
          Default implicit constructor.
  ObjectTool(NXCPMessage msg, long baseId)
          Create object tool from NXCP message.
 
Method Summary
protected  void createDisplayName()
          Create display name
 java.lang.String getConfirmationText()
           
 java.lang.String getData()
           
 java.lang.String getDescription()
           
 java.lang.String getDisplayName()
           
 int getFlags()
           
 long getId()
           
 java.lang.String getName()
           
 java.lang.String getSnmpOid()
           
 int getType()
           
 boolean isApplicableForNode(Node node)
          Check if tool is applicable for given node.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_INTERNAL

public static final int TYPE_INTERNAL
See Also:
Constant Field Values

TYPE_ACTION

public static final int TYPE_ACTION
See Also:
Constant Field Values

TYPE_TABLE_SNMP

public static final int TYPE_TABLE_SNMP
See Also:
Constant Field Values

TYPE_TABLE_AGENT

public static final int TYPE_TABLE_AGENT
See Also:
Constant Field Values

TYPE_URL

public static final int TYPE_URL
See Also:
Constant Field Values

TYPE_LOCAL_COMMAND

public static final int TYPE_LOCAL_COMMAND
See Also:
Constant Field Values

TYPE_SERVER_COMMAND

public static final int TYPE_SERVER_COMMAND
See Also:
Constant Field Values

TYPE_FILE_DOWNLOAD

public static final int TYPE_FILE_DOWNLOAD
See Also:
Constant Field Values

REQUIRES_SNMP

public static final int REQUIRES_SNMP
See Also:
Constant Field Values

REQUIRES_AGENT

public static final int REQUIRES_AGENT
See Also:
Constant Field Values

REQUIRES_OID_MATCH

public static final int REQUIRES_OID_MATCH
See Also:
Constant Field Values

ASK_CONFIRMATION

public static final int ASK_CONFIRMATION
See Also:
Constant Field Values

GENERATES_OUTPUT

public static final int GENERATES_OUTPUT
See Also:
Constant Field Values

SNMP_INDEXED_BY_VALUE

public static final int SNMP_INDEXED_BY_VALUE
See Also:
Constant Field Values

id

protected long id

name

protected java.lang.String name

displayName

protected java.lang.String displayName

type

protected int type

flags

protected int flags

description

protected java.lang.String description

snmpOid

protected java.lang.String snmpOid

data

protected java.lang.String data

confirmationText

protected java.lang.String confirmationText
Constructor Detail

ObjectTool

protected ObjectTool()
Default implicit constructor.


ObjectTool

public ObjectTool(NXCPMessage msg,
                  long baseId)
Create object tool from NXCP message. Intended to be called only by NXCSession methods.

Parameters:
msg - NXCP message
baseId - Base variable ID
Method Detail

createDisplayName

protected void createDisplayName()
Create display name


isApplicableForNode

public boolean isApplicableForNode(Node node)
Check if tool is applicable for given node.

Parameters:
node - Node object
Returns:
true if tool is applicable for given node

getId

public long getId()
Returns:
the id

getName

public java.lang.String getName()
Returns:
the name

getType

public int getType()
Returns:
the type

getFlags

public int getFlags()
Returns:
the flags

getDescription

public java.lang.String getDescription()
Returns:
the description

getSnmpOid

public java.lang.String getSnmpOid()
Returns:
the snmpOid

getData

public java.lang.String getData()
Returns:
the data

getConfirmationText

public java.lang.String getConfirmationText()
Returns:
the confirmationText

getDisplayName

public java.lang.String getDisplayName()
Returns:
the displayName


Copyright © 2012. All Rights Reserved.