ObjectTool (netxms-client 2.2.3 API)

java.lang.Object
- org.netxms.client.objecttools.ObjectTool

All Implemented Interfaces:

ObjectAction

Direct Known Subclasses:

ObjectToolDetails
```
public class ObjectTool
extends Object
implements ObjectAction
```
NetXMS object tool representation

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ASK_CONFIRMATION`
`protected String`	`commandName`
`protected String`	`commandShortName`
`protected String`	`confirmationText`
`protected String`	`data`
`protected String`	`description`
`static int`	`DISABLED`
`protected String`	`displayName`
`protected ObjectMenuFilter`	`filter`
`protected int`	`flags`
`static int`	`GENERATES_OUTPUT`
`protected long`	`id`
`protected byte[]`	`imageData`
`protected Map<String,InputField>`	`inputFields`
`protected String`	`name`
`static int`	`SHOW_IN_COMMANDS`
`static int`	`SNMP_INDEXED_BY_VALUE`
`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_SERVER_SCRIPT`
`static int`	`TYPE_TABLE_AGENT`
`static int`	`TYPE_TABLE_SNMP`
`static int`	`TYPE_URL`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ObjectTool()` Default implicit constructor.
	`ObjectTool(org.netxms.base.NXCPMessage msg, long baseId)` Create object tool from NXCP message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`createDisplayName()` Create display name
`String`	`getCommandDisplayName()` Get command display name
`String`	`getCommandName()` Get command name
`String`	`getCommandShortDisplayName()` Get command short display name
`String`	`getCommandShortName()` Get command short name
`String`	`getConfirmationText()`
`String`	`getData()`
`String`	`getDescription()`
`String`	`getDisplayName()`
`int`	`getFlags()`
`long`	`getId()` Get tool ID
`byte[]`	`getImageData()`
`InputField`	`getInputField(String name)` Get input field definition by name
`InputField[]`	`getInputFields()` Get all input fields
`ObjectMenuFilter`	`getMenuFilter()` Get menu filter associated with the tool
`String`	`getName()`
`String`	`getSnmpOid()`
`String`	`getToolNodeOS()`
`String`	`getToolTemplate()`
`int`	`getToolType()` Get tool type
`String`	`getToolWorkstationOS()`
`boolean`	`isApplicableForNode(AbstractNode node)` Check if tool is applicable for given node.
`boolean`	`isEnabled()` Check if tool is enabled
`boolean`	`isVisibleInCommands()` Check if this tool should be visible in commands
`void`	`setMenuFilter(ObjectMenuFilter filter)` Sets menu filter for the tool
`protected void`	`validateInputFields()` Check if all input fields referenced in tool have definitions

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
  - TYPE_SERVER_SCRIPT
```
public static final int TYPE_SERVER_SCRIPT
```
    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
  - DISABLED
```
public static final int DISABLED
```
    See Also:
    
    Constant Field Values
  - SHOW_IN_COMMANDS
```
public static final int SHOW_IN_COMMANDS
```
    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 String name
```
  - displayName
```
protected String displayName
```
  - type
```
protected int type
```
  - flags
```
protected int flags
```
  - description
```
protected String description
```
  - data
```
protected String data
```
  - confirmationText
```
protected String confirmationText
```
  - commandName
```
protected String commandName
```
  - commandShortName
```
protected String commandShortName
```
  - filter
```
protected ObjectMenuFilter filter
```
  - imageData
```
protected byte[] imageData
```
  - inputFields
```
protected Map<String,InputField> inputFields
```
- Constructor Detail
  - ObjectTool
```
protected ObjectTool()
```
    Default implicit constructor.
  - ObjectTool
```
public ObjectTool(org.netxms.base.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
  - validateInputFields
```
protected void validateInputFields()
```
    Check if all input fields referenced in tool have definitions
  - createDisplayName
```
protected void createDisplayName()
```
    Create display name
  - isApplicableForNode
```
public boolean isApplicableForNode(AbstractNode node)
```
    Check if tool is applicable for given node.
    
    Specified by:
    
    isApplicableForNode in interface ObjectAction
    
    Parameters:
    
    node - AbstractNode object
    
    Returns:
    
    true if tool is applicable for given node
  - getInputField
```
public InputField getInputField(String name)
```
    Get input field definition by name
    
    Parameters:
    
    name - input field name
    
    Returns:
    
    input field or null if not found
  - getInputFields
```
public InputField[] getInputFields()
```
    Get all input fields
    
    Returns:
    
    list of all defined input fields
  - getId
```
public long getId()
```
    Get tool ID
    
    Returns:
    
    tool ID
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - getToolType
```
public int getToolType()
```
    Description copied from interface: ObjectAction
    
    Get tool type
    
    Specified by:
    
    getToolType in interface ObjectAction
    
    Returns:
    
    the type
  - getFlags
```
public int getFlags()
```
    Returns:
    
    the flags
  - isVisibleInCommands
```
public boolean isVisibleInCommands()
```
    Check if this tool should be visible in commands
    
    Returns:
    
    true if this tool should be visible in commands
  - isEnabled
```
public boolean isEnabled()
```
    Check if tool is enabled
    
    Returns:
    
    true if enabled
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - getSnmpOid
```
public String getSnmpOid()
```
    Returns:
    
    the snmpOid
  - getData
```
public String getData()
```
    Returns:
    
    the data
  - getConfirmationText
```
public String getConfirmationText()
```
    Returns:
    
    the confirmationText
  - getDisplayName
```
public String getDisplayName()
```
    Returns:
    
    the displayName
  - getCommandName
```
public String getCommandName()
```
    Get command name
    
    Returns:
    
    command name
  - getCommandDisplayName
```
public String getCommandDisplayName()
```
    Get command display name
    
    Returns:
    
    command display name
  - getCommandShortName
```
public String getCommandShortName()
```
    Get command short name
    
    Returns:
    
    command short name
  - getCommandShortDisplayName
```
public String getCommandShortDisplayName()
```
    Get command short display name
    
    Returns:
    
    command short display name
  - getImageData
```
public byte[] getImageData()
```
    Returns:
    
    the imageData
  - getToolNodeOS
```
public String getToolNodeOS()
```
    Returns:
    
    the toolRemOS
  - getToolWorkstationOS
```
public String getToolWorkstationOS()
```
    Returns:
    
    the toolLocOS
  - getToolTemplate
```
public String getToolTemplate()
```
    Returns:
    
    the toolTemplate
  - getMenuFilter
```
public ObjectMenuFilter getMenuFilter()
```
    Description copied from interface: ObjectAction
    
    Get menu filter associated with the tool
    
    Specified by:
    
    getMenuFilter in interface ObjectAction
  - setMenuFilter
```
public void setMenuFilter(ObjectMenuFilter filter)
```
    Description copied from interface: ObjectAction
    
    Sets menu filter for the tool
    
    Specified by:
    
    setMenuFilter in interface ObjectAction

Class ObjectTool

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_INTERNAL

TYPE_ACTION

TYPE_TABLE_SNMP

TYPE_TABLE_AGENT

TYPE_URL

TYPE_LOCAL_COMMAND

TYPE_SERVER_COMMAND

TYPE_FILE_DOWNLOAD

TYPE_SERVER_SCRIPT

ASK_CONFIRMATION

GENERATES_OUTPUT

DISABLED

SHOW_IN_COMMANDS

SNMP_INDEXED_BY_VALUE

id

name

displayName

type

flags

description

data

confirmationText

commandName

commandShortName

filter

imageData

inputFields

Constructor Detail

ObjectTool

ObjectTool

Method Detail

validateInputFields

createDisplayName

isApplicableForNode

getInputField

getInputFields

getId

getName

getToolType

getFlags

isVisibleInCommands

isEnabled

getDescription

getSnmpOid

getData

getConfirmationText

getDisplayName

getCommandName

getCommandDisplayName

getCommandShortName

getCommandShortDisplayName

getImageData

getToolNodeOS

getToolWorkstationOS

getToolTemplate

getMenuFilter

setMenuFilter