Package org.netxms.client.objecttools

Class ObjectToolDetails

java.lang.Object

org.netxms.client.objecttools.ObjectTool

org.netxms.client.objecttools.ObjectToolDetails

All Implemented Interfaces:

ObjectAction

public class ObjectToolDetails
extends ObjectTool

Detailed information about object tool

Field Summary

Fields inherited from class org.netxms.client.objecttools.ObjectTool

ASK_CONFIRMATION, commandName, commandShortName, confirmationText, data, description, DISABLED, displayName, filter, flags, GENERATES_OUTPUT, id, imageData, inputFields, name, remotePort, RUN_IN_CONTAINER_CONTEXT, SETUP_TCP_TUNNEL, SHOW_IN_COMMANDS, SNMP_INDEXED_BY_VALUE, SUPPRESS_SUCCESS_MESSAGE, type, TYPE_ACTION, TYPE_AGENT_LIST, TYPE_AGENT_TABLE, TYPE_FILE_DOWNLOAD, TYPE_INTERNAL, TYPE_LOCAL_COMMAND, TYPE_SERVER_COMMAND, TYPE_SERVER_SCRIPT, TYPE_SNMP_TABLE, TYPE_SSH_COMMAND, TYPE_URL

Constructor Summary

Constructors

Constructor	Description
ObjectToolDetails(long toolId, int type, String name)	Create new tool object
ObjectToolDetails(NXCPMessage msg)	Create object tool from NXCP message containing detailed tool information.

Method Summary

Modifier and Type	Method	Description
void	addInputField(InputField f)	Add or replace input field definition.
void	fillMessage(NXCPMessage msg)	Fill NXCP message with tool's data.
List<Integer>	getAccessList()
List<ObjectToolTableColumn>	getColumns()
boolean	isModified()
void	setAccessList(List<Integer> accessList)
void	setColumns(List<ObjectToolTableColumn> columns)
void	setCommandName(String commandName)	Set command name (to be displayed in command list).
void	setCommandShortName(String commandShortName)	Set short command name (to be displayed in command list when UI requires short name, usually on toolbars and buttons).
void	setConfirmationText(String confirmationText)
void	setData(String data)
void	setDescription(String description)
void	setFilter(String filterText, int filterType)	Update menu filter information
void	setFilterFlags(int flags)	Update menu filter flags
void	setFlags(int flags)
void	setId(long id)	Set tool ID.
void	setImageData(byte[] imageData)	Set image data (for displaying tool icon).
void	setInputFields(Collection<InputField> fields)	Set input field definitions
void	setName(String name)	Set tool name.
void	setRemotePort(int remotePort)	Set remote TCP port number for TCP tunnel.
void	setType(int type)

Methods inherited from class org.netxms.client.objecttools.ObjectTool

createDisplayName, getCommandDisplayName, getCommandName, getCommandShortDisplayName, getCommandShortName, getConfirmationText, getData, getDescription, getDisplayName, getFlags, getId, getImageData, getInputField, getInputFields, getMenuFilter, getName, getRemotePort, getSnmpOid, getToolNodeOS, getToolTemplate, getToolType, getToolWorkstationOS, isApplicableForObject, isContainerObject, isEnabled, isRunInContainerContext, isVisibleInCommands, setMenuFilter, validateInputFields

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ObjectToolDetails

public ObjectToolDetails(long toolId,
 int type,
 String name)

Create new tool object

Parameters:

toolId - tool id

type - tool type

name - tool name

ObjectToolDetails

public ObjectToolDetails(NXCPMessage msg)

Create object tool from NXCP message containing detailed tool information. Intended to be called only by NXCSession methods.

Parameters:

msg - NXCP message

Method Details

fillMessage

public void fillMessage(NXCPMessage msg)

Fill NXCP message with tool's data.

Parameters:

msg - NXCP message

getAccessList

public List<Integer> getAccessList()

Returns:

the accessList

getColumns

public List<ObjectToolTableColumn> getColumns()

Returns:

the columns

addInputField

public void addInputField(InputField f)

Add or replace input field definition.

Parameters:

f - new input field

setInputFields

public void setInputFields(Collection<InputField> fields)

Set input field definitions

Parameters:

fields - new set of input fields

setId

public void setId(long id)

Set tool ID.

Parameters:

id - new tool ID

setName

public void setName(String name)

Set tool name.

Parameters:

name - new name

setType

public void setType(int type)

Parameters:

type - the type to set

setFlags

public void setFlags(int flags)

Parameters:

flags - the flags to set

setDescription

public void setDescription(String description)

Parameters:

description - the description to set

setData

public void setData(String data)

Parameters:

data - the data to set

setConfirmationText

public void setConfirmationText(String confirmationText)

Parameters:

confirmationText - the confirmationText to set

setRemotePort

public void setRemotePort(int remotePort)

Set remote TCP port number for TCP tunnel.

Parameters:

remotePort - remote TCP port number

isModified

public boolean isModified()

Returns:

the modified

setAccessList

public void setAccessList(List<Integer> accessList)

Parameters:

accessList - the accessList to set

setColumns

public void setColumns(List<ObjectToolTableColumn> columns)

Parameters:

columns - the columns to set

setCommandName

public void setCommandName(String commandName)

Set command name (to be displayed in command list).

Parameters:

commandName - new command name for this tool

setCommandShortName

public void setCommandShortName(String commandShortName)

Set short command name (to be displayed in command list when UI requires short name, usually on toolbars and buttons).

Parameters:

commandShortName - new short command name for this tool

setImageData

public void setImageData(byte[] imageData)

Set image data (for displaying tool icon).

Parameters:

imageData - new image data

setFilter

public void setFilter(String filterText,
 int filterType)

Update menu filter information

Parameters:

filterText - menu filter text

filterType - menu filter type

setFilterFlags

public void setFilterFlags(int flags)

Update menu filter flags

Parameters:

flags - new value for menu filter flag

See Also:

• ObjectMenuFilter