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 Details

    • TRANSLATION_FIELD_NAME

      public static final String TRANSLATION_FIELD_NAME
      Translatable field tags. Mirror the LOCSTR_TAG_* constants on the server.
      See Also:

    • TRANSLATION_FIELD_DESCRIPTION

      public static final String TRANSLATION_FIELD_DESCRIPTION
      See Also:

    • TRANSLATION_FIELD_CONFIRMATION_TEXT

      public static final String TRANSLATION_FIELD_CONFIRMATION_TEXT
      See Also:

    • TRANSLATION_FIELD_COMMAND_NAME

      public static final String TRANSLATION_FIELD_COMMAND_NAME
      See Also:

    • TRANSLATION_FIELD_COMMAND_SHORT_NAME

      public static final String TRANSLATION_FIELD_COMMAND_SHORT_NAME
      See Also:

  • 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

    • setRemoteHost

      public void setRemoteHost(String remoteHost)
      Set remote host name for TCP tunnel.
      Parameters:
      remoteHost - remote host name

    • 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

    • setIcon

      public void setIcon(UUID icon)
      Set icon as image library reference.
      Parameters:
      icon - image library UUID, or null to clear

    • 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:

    • setApplicableClasses

      public void setApplicableClasses(int applicableClasses)
      Set applicable object classes bitmask.
      Parameters:
      applicableClasses - combination of APPLICABLE_* bits

    • getTranslations

      public Map<String,Map<String,String>> getTranslations()
      Get the translations map (language code -> field tag -> localized value). Field tags match the TRANSLATION_FIELD_* constants. Returned map is mutable.
      Returns:
      translations map

    • setTranslations

      public void setTranslations(Map<String,Map<String,String>> translations)
      Replace the translations map.
      Parameters:
      translations - new translations (language -> field tag -> value)