Package com.uc4.communication.requests

Class ExecuteObjects

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ExecuteObjects

public class ExecuteObjects
extends XMLRequest

Executes list of UC4Objects and returns the corresponding response list

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ExecuteObjects.ExecuteObjectsResponse	Class hold response data from the executed request

Constructor Summary

Constructors

Constructor	Description
ExecuteObjects(List<UC4ObjectName> uC4ObjectNames)	Constructs a ExecuteObjects using the specified object name list.

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.
protected 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.
Iterator<ExecuteObjects.ExecuteObjectsResponse>	reponseIterator()	Returns an iterator over the responses
int	responseCount()	Returns the number of responses

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, isAllowedInClientZero, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Constructor Details

ExecuteObjects

public ExecuteObjects(List<UC4ObjectName> uC4ObjectNames)

Constructs a ExecuteObjects using the specified object name list. The method Connection#sendRequest has to be used if this object needs interactive input (Form). In this case Connection#sendRequestAndWait would block infinitely.

Parameters:

uC4ObjectNames - list of the UC4 object that need to be executed.

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

reponseIterator

public Iterator<ExecuteObjects.ExecuteObjectsResponse> reponseIterator()

Returns an iterator over the responses

Returns:

an Iterator, never null

responseCount

public int responseCount()

Returns the number of responses

Returns:

Integer containing the number of responses