Package com.uc4.communication.requests

Class PromptInputHelp

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.PromptInputHelp
public class PromptInputHelp extends XMLRequest
Returns a table with values for input help in PromptElements.

  • Constructor Details

    • PromptInputHelp

      public PromptInputHelp(String variableName, UC4ObjectName promptSet, int runID, String filterText, int filterColumn, TaskPromptSetNames names, TaskPromptSetContent... content)
      Creates an input help based on values entered in prompts.
      Parameters:
      variableName - Name of the variable for which an input help should be generated
      promptSet - UC4ObjectName
      runID - RunID
      filterText - Filter content, can be null
      filterColumn - Filter column, the first column starts with 0
      names - PromptSet names
      content - PromptSet content

    • PromptInputHelp

      @Deprecated public PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn)
      Deprecated.
      Use PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn, UC4Object object) instead
      Input help of Prompt values.
      Parameters:
      variableName - Script variable name of the PromptElement
      promptSet - Name of the PromptSet object which contains the PromptElement
      filter - Filter, may contain wildcards, may be null
      filterColumn - Filter column starting with 0

    • PromptInputHelp

      public PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn, UC4Object object)
      Input help of Prompt values for objects.
      Parameters:
      variableName - Script variable name of the PromptElement
      promptSet - Name of the PromptSet object which contains the PromptElement
      filter - Filter, may contain wildcards, may be null
      filterColumn - Filter column starting with 0,
      object - Object

    • PromptInputHelp

      public PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn, ITaskItem task)
      Input help of Prompt values for objects.
      Parameters:
      variableName - Script variable name of the PromptElement
      promptSet - Name of the PromptSet object which contains the PromptElement
      filter - Filter, may contain wildcards, may be null
      filterColumn - Filter column starting with 0,
      task - Task in the Workflow

  • Method Details

    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source

    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session

    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session

    • isMultiselect

      public boolean isMultiselect()
      Does this prompt input helper support multi selection.
      Returns:
      True when multi select is supported, false when it is not.

    • size

      public int size()
      Returns the number of data rows in the table.
      Returns:
      Number of rows

    • getRow

      public String[] getRow(int index)
      Returns the data of the specified row.
      Parameters:
      index - Index, 0 to size() -1
      Returns:
      String array containing the data

    • getColumnNames

      public String[] getColumnNames()
      Returns a String array which contains the names of the columns.
      Returns:
      Column names

    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise