Class NavigatorQueueTree

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

public class NavigatorQueueTree extends XMLRequest implements Iterable<NavigatorQueueTree.QueueNode>
Represents the queue tree in the activity window navigator.
  • Constructor Details

    • NavigatorQueueTree

      public NavigatorQueueTree()
  • 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
    • iterator

      Returns an Iterator which can be used to step through the QueueNode items of the root.
      Specified by:
      iterator in interface Iterable<NavigatorQueueTree.QueueNode>
      Returns:
      Iterator containing QueueNode
    • 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
    • size

      public int size()
      Returns the number of top level items in the Navigation Queue Tree.
      Returns:
      number of QueueItem
    • setClient

      public void setClient(int client)
      Sets a specific client as filter for the NavigatorQueueTree. This method is only used for client 0. For all clients other 0 it has no effect.
      Parameters:
      client - filter for the NavigatorQueueTree