Package com.uc4.communication.requests

Class ActivityList

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.ActivityList
All Implemented Interfaces:
Iterable<Task>
public class ActivityList extends XMLRequest implements Iterable<Task>
Returns a list of tasks according to the TaskFilter.

  • Constructor Details

    • ActivityList

      public ActivityList(TaskFilter filter)
      Creates a ActivityList using the specified TaskFilter.
      Parameters:
      filter - Taskfilter

    • ActivityList

      public ActivityList(TaskFilter filter, boolean treeMode)
      Creates a ActivityList using the specified TaskFilter for tree oder list mode. Tree mode: in the tree mode the hierarchical view of the Activity Window is returned. That means the top level activities. To expand sub level activities as well, use setExpandedRunIds. List mode: all activities are returned.
      Parameters:
      filter - Taskfilter
      treeMode - If true the tree view of the Activity Window is returned, if false the list view is returned.

  • 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

    • sortByNameAscending

      public void sortByNameAscending()
      Sorts the result from the server. This method must be called after the request has been sent and before the iterator method is called. The Iterator will then return the tasks in the specified order.

    • sortByNameDescending

      public void sortByNameDescending()
      Sorts the result from the server. This method must be called after the request has been sent and before the iterator method is called. The Iterator will then return the tasks in the specified order.

    • 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

    • size

      public int size()
      Returns the number of tasks. If the request is not sent this method returns 0.
      Returns:
      Integer containing the number of activities

    • iterator

      public Iterator<Task> iterator()
      Returns an iterator over the Task elements in this activity list. If this request has not been sent the return value is null
      Specified by:
      iterator in interface Iterable<Task>
      Returns:
      an Iterator over the Task elements in this activity list

    • setExpandedRunIds

      public void setExpandedRunIds(List<Integer> runIds)
      Sets the RundIds of Tasks that should be expanded. Only used if ActivityList is used in tree modus.
      Parameters:
      runIds - RundIds of the tasks, that should be expanded.

    • setGroupingType

      public void setGroupingType(ActivityList.GroupingType groupingType)
      Sets the grouping type for the activity window.
      Parameters:
      groupingType - GroupingType

    • setClient

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

    • 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