Package com.uc4.communication.requests
Class TaskDetails
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.TaskDetails
Gets the details of task in the activity window or statistic.
-
Constructor Summary
ConstructorsConstructorDescriptionTaskDetails
(int run) Constructs aTaskDetails
using the specified RunID.TaskDetails
(UserListItem user) Creates a new request to read the details of a logged on user. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.findByName
(String name) Returns the value of the specified property name.protected String
getIdnr()
Return the idnr attributeprotected String
getSrc()
Returns the request source.Returns an iterator overDetailGroup
.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
This method is used internally.void
If this method is called the detail of a task in the activity list is returned.void
If this method is called the detail of a task in the statistics is returned.void
If this method is called the detail of a task in the autoforecast list is returned.int
size()
Returns the number of groups.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 Details
-
TaskDetails
public TaskDetails(int run) Constructs aTaskDetails
using the specified RunID. The detail type is set to statistics. To get the detail of a task in the activity list the methodsetActivityDetail
can be called.- Parameters:
run
- entry returned from a statistic search
-
TaskDetails
Creates a new request to read the details of a logged on user.- Parameters:
user
- Entry in the user list- Throws:
IllegalArgumentException
- if the user is not logged on: UserListItem.isLoggedOn() returns false
-
-
Method Details
-
setActivityDetail
public void setActivityDetail()If this method is called the detail of a task in the activity list is returned. -
setForecastDetail
public void setForecastDetail()If this method is called the detail of a task in the autoforecast list is returned. -
setArchiveDetail
public void setArchiveDetail()If this method is called the detail of a task in the statistics is returned. -
groupIterator
Returns an iterator overDetailGroup
.- Returns:
- iterator over
DetailGroup
-
size
public int size()Returns the number of groups.- Returns:
- Integer containing the number of groups
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
getIdnr
Return the idnr attribute- Returns:
- The idnr value as string
-
findByName
Returns the value of the specified property name.This method searches for the name in all sections and all groups of this detail. * The name of a property depends on the language.
- Parameters:
name
- Name of the property- Returns:
- Value or null if the name is not found.
-
handleContent
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
-
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
-