Package com.uc4.communication.requests

Class SubmitPrompt

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.SubmitPrompt

public class SubmitPrompt
extends XMLRequest

Submits a list of PromptSet values to continue with the execution of an UC4 Object.

Constructor Summary

Constructors

Constructor	Description
SubmitPrompt(TaskPromptSetNames names, TaskPromptSetContent... content)	Creates a new SubmitPrompt request.

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.
boolean	isResubmitRequired()	This method returns true if the server did not accept the submit because of invalid fields.

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

SubmitPrompt

public SubmitPrompt(TaskPromptSetNames names,
 TaskPromptSetContent... content)

Creates a new SubmitPrompt request.

Parameters:

names - Names of PromptSets

content - Content of PromptSets

Method Details

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

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

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

isResubmitRequired

public boolean isResubmitRequired()

This method returns true if the server did not accept the submit because of invalid fields. In this case the input needs to be corrected and submitted again.

Returns:

true if resubmit is required, false if the data has been accepted.