Package com.uc4.communication.requests

Class AddPromptSet

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.AddPromptSet

public class AddPromptSet
extends XMLRequest

Returns a PromptSet definition. This request also checks if the PromptSet exists in UC4.

Constructor Summary

Constructors

Constructor	Description
AddPromptSet(UC4ObjectName promptSetName)	Deprecated. Use constructor with passed UC4Object
AddPromptSet(UC4ObjectName promptSetName, UC4Object obj)	Constructs a new AddPromptSet request using the specified PromptSet name.

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.
PromptSetDefinition	getPromptSet()	Returns the Prompt Set definition.
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.
protected boolean	isAllowedInClientZero()	This method is used internally.

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

AddPromptSet

@Deprecated
public AddPromptSet(UC4ObjectName promptSetName)

Deprecated.

Use constructor with passed UC4Object

Constructs a new AddPromptSet request using the specified PromptSet name.

Parameters:

promptSetName - Name of the PromptSet object

AddPromptSet

public AddPromptSet(UC4ObjectName promptSetName,
 UC4Object obj)

Constructs a new AddPromptSet request using the specified PromptSet name.

Parameters:

promptSetName - Name of the PromptSet object

obj - UC4 Object

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

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

getPromptSet

public PromptSetDefinition getPromptSet()

Returns the Prompt Set definition.

Returns:

Prompt Set definition

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

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