Class QuickSearch

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.QuickSearch
All Implemented Interfaces:
Iterable<QuickSearchItem>

public class QuickSearch extends XMLRequest implements Iterable<QuickSearchItem>
Gets a list of object names which contain a defined pattern.
  • Constructor Details

    • QuickSearch

      public QuickSearch(String pat)
      Create a new QuickAccess request.
      Parameters:
      pat - Part of the object name
  • Method Details

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

      public Iterator<QuickSearchItem> iterator()
      Returns an java.util.Iterator which can be used to read the result items.
      Specified by:
      iterator in interface Iterable<QuickSearchItem>
      Returns:
      Iterator over QuickAccessItem
    • size

      public int size()
      Returns the number of items in the response.
      Returns:
      Number of returned items
    • 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
    • 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