Package com.uc4.communication.requests

Class AddScheduleTask

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.AddScheduleTask

public class AddScheduleTask
extends XMLRequest

Reads a task description. The returned task can be added to a schedule.

Constructor Summary

Constructors

Constructor	Description
AddScheduleTask(UC4ObjectName name)	Constructs a AddScheduleTask request using the specified 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.
ScheduleTask	getScheduleTask()	Returns a ScheduleTask which can be added to an UC4 Schedule.
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

AddScheduleTask

public AddScheduleTask(UC4ObjectName name)

Constructs a AddScheduleTask request using the specified name. The UC4 Server returns a task description if a task with this name exists. If an UC4 object with the specified name is not found a message box is returned. The method getScheduleTask can be used to get the returned AddScheduleTask

Parameters:

name - UC4ObjectName of the object which should be added to the schedule

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

getScheduleTask

public ScheduleTask getScheduleTask()

Returns a ScheduleTask which can be added to an UC4 Schedule.

Returns:

ScheduleTask

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