Package com.uc4.communication.requests

Class TaskDetails

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.TaskDetails

public class TaskDetails
extends XMLRequest

Gets the details of task in the activity window or statistic.

Constructor Summary

Constructors

Constructor	Description
TaskDetails(int run)	Constructs a TaskDetails using the specified RunID.
TaskDetails(UserListItem user)	Creates a new request to read the details of a logged on user.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
String	findByName(String name)	Returns the value of the specified property name.
protected String	getIdnr()	Return the idnr attribute
protected String	getSrc()	Returns the request source.
Iterator<DetailGroup>	groupIterator()	Returns an iterator over DetailGroup.
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.
void	setActivityDetail()	If this method is called the detail of a task in the activity list is returned.
void	setArchiveDetail()	If this method is called the detail of a task in the statistics is returned.
void	setForecastDetail()	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TaskDetails

public TaskDetails(int run)

Constructs a TaskDetails using the specified RunID. The detail type is set to statistics. To get the detail of a task in the activity list the method setActivityDetail can be called.

Parameters:

run - entry returned from a statistic search

TaskDetails

public TaskDetails(UserListItem user)

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

public Iterator<DetailGroup> groupIterator()

Returns an iterator over DetailGroup.

Returns:

iterator over DetailGroup

size

public int size()

Returns the number of groups.

Returns:

Integer containing the number of groups

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

getIdnr

protected String getIdnr()

Return the idnr attribute

Returns:

The idnr value as string

findByName

public String findByName(String name)

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

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

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