Package com.uc4.communication.requests
Class ActivityList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.ActivityList
-
- All Implemented Interfaces:
java.lang.Iterable<Task>
public class ActivityList extends XMLRequest implements java.lang.Iterable<Task>
Returns a list of tasks according to theTaskFilter
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActivityList.GroupingType
Grouping criteria for the activity window.
-
Constructor Summary
Constructors Constructor Description ActivityList(TaskFilter filter)
Creates aActivityList
using the specifiedTaskFilter
.ActivityList(TaskFilter filter, boolean treeMode)
Creates aActivityList
using the specifiedTaskFilter
for tree oder list mode.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
Creates the XML Document for the request.protected java.lang.String
getSrc()
Returns the request source.protected void
handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
Sub classes extract the values from the XML document and provide public getter methods.protected boolean
isAllowedInClientZero()
This method is used internally.java.util.Iterator<Task>
iterator()
Returns an iterator over theTask
elements in this activity list.void
setClient(int client)
Sets a specific client as filter for theActivityList
.void
setExpandedRunIds(java.util.List<java.lang.Integer> runIds)
Sets the RundIds of Tasks that should be expanded.void
setGroupingType(ActivityList.GroupingType groupingType)
Sets the grouping type for the activity window.int
size()
Returns the number of tasks.void
sortByNameAscending()
Sorts the result from the server.void
sortByNameDescending()
Sorts the result from the server.-
Methods inherited from class com.uc4.communication.requests.XMLRequest
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
-
-
-
-
Constructor Detail
-
ActivityList
public ActivityList(TaskFilter filter)
Creates aActivityList
using the specifiedTaskFilter
.- Parameters:
filter
- Taskfilter
-
ActivityList
public ActivityList(TaskFilter filter, boolean treeMode)
Creates aActivityList
using the specifiedTaskFilter
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, usesetExpandedRunIds
. List mode: all activities are returned.- Parameters:
filter
- TaskfiltertreeMode
- Iftrue
the tree view of the Activity Window is returned, iffalse
the list view is returned.
-
-
Method Detail
-
getSrc
protected java.lang.String getSrc()
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 theiterator
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 theiterator
method is called. The Iterator will then return the tasks in the specified order.
-
createRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- 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 java.util.Iterator<Task> iterator()
Returns an iterator over theTask
elements in this activity list. If this request has not been sent the return value isnull
- Specified by:
iterator
in interfacejava.lang.Iterable<Task>
- Returns:
- an Iterator over the
Task
elements in this activity list
-
setExpandedRunIds
public void setExpandedRunIds(java.util.List<java.lang.Integer> runIds)
Sets the RundIds of Tasks that should be expanded. Only used ifActivityList
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 theActivityList
. This method is only used for client 0. For all clients other 0 it has no effect.- Parameters:
client
- filter for theActivityList
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()
Description copied from class:XMLRequest
This method is used internally. Tests if thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-
-