Package org.netxms.client.objects.queries

Class ObjectQuery

java.lang.Object
org.netxms.client.objects.queries.ObjectQuery
public class ObjectQuery extends Object
Predefined object query

  • Constructor Details

    • ObjectQuery

      public ObjectQuery(String name, String description, String source)
      Create new object query definition.
      Parameters:
      name - query name
      description - query description
      source - query source code

    • ObjectQuery

      public ObjectQuery(NXCPMessage msg, long[] baseId)
      Create object query definition from NXCP message.
      Parameters:
      msg - NXCP message
      baseId - single-element array containing base field ID. Will be updated to base field ID for next element in message.

  • Method Details

    • fillMessage

      public void fillMessage(NXCPMessage msg)
      Fill NXCP message with query data.
      Parameters:
      msg - NXCP message

    • getName

      public String getName()
      Get query name.
      Returns:
      query name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getDescription

      public String getDescription()
      Returns:
      the description

    • setDescription

      public void setDescription(String description)
      Parameters:
      description - the description to set

    • getSource

      public String getSource()
      Get query source code.
      Returns:
      query source code

    • setSource

      public void setSource(String source)
      Set query source code.
      Parameters:
      source - new query source code

    • getId

      public int getId()
      Get query ID.
      Returns:
      query ID

    • setId

      public void setId(int id)
      Parameters:
      id - the id to set

    • getGuid

      public UUID getGuid()
      Get query GUID.
      Returns:
      query GUID

    • isValid

      public boolean isValid()
      Check if query is valid (compiled successfully and ready to run).
      Returns:
      true if query is valid

    • getInputFields

      public List<InputField> getInputFields()
      Get list of all defined input fields.
      Returns:
      list of all defined input fields

    • getInputField

      public InputField getInputField(String name)
      Get definition of input field with given name.
      Parameters:
      name - field name
      Returns:
      input field definition or null

    • addInputField

      public void addInputField(InputField f)
      Add input field. If field definition with same name already exist, it will be replaced.
      Parameters:
      f - input field definition

    • removeInputField

      public void removeInputField(String name)
      Remove input field with given name.
      Parameters:
      name - field name

    • setInputFileds

      public void setInputFileds(Collection<InputField> fields)
      Replace existing definitions of input fields with newly provided set.
      Parameters:
      fields - new set of input field definitions