Package com.uc4.communication.requests

Class AddScheduleMonitorTask

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.AddScheduleMonitorTask

public class AddScheduleMonitorTask
extends XMLRequest

Adds a task to a started schedule via its monitor.

Constructor Summary

Constructors

Constructor	Description
AddScheduleMonitorTask(UC4ObjectName name, int parentIdnr)	Constructs a AddScheduleMonitorTask request using the specified name and add it to the parent task of given parentIdnr.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected ScheduleMonitor.Task	createTask(org.w3c.dom.Element taskElement, ConnectionAttributes session, boolean srcEH, int runID, com.uc4.util.XMLDocument doc)	Creates a task in the Schedule monitor.
ScheduleMonitor.Task	getScheduleMonitorTask()	Returns a ScheduleMonitor.Task which has been added to running schedule corresponding to given parentIdnr.
protected java.lang.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 Detail

AddScheduleMonitorTask

public AddScheduleMonitorTask(UC4ObjectName name,
                              int parentIdnr)

Constructs a AddScheduleMonitorTask request using the specified name and add it to the parent task of given parentIdnr. 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 getScheduleMonitorTask can be used to get the returned ScheduleMonitor.Task

Parameters:

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

parentIdnr - idnr of the parent schedule to which this new task is to be added

Method Detail

getSrc

protected java.lang.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,
                             org.w3c.dom.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

createTask

protected ScheduleMonitor.Task createTask(org.w3c.dom.Element taskElement,
                                          ConnectionAttributes session,
                                          boolean srcEH,
                                          int runID,
                                          com.uc4.util.XMLDocument doc)

Creates a task in the Schedule monitor. Sub classes may override this method.

Parameters:

taskElement - XML Element of the task

session - Session Info

srcEH - The schedule source info

runID - The schedule run id

doc - XMLDocument instance

Returns:

Task

getScheduleMonitorTask

public ScheduleMonitor.Task getScheduleMonitorTask()

Returns a ScheduleMonitor.Task which has been added to running schedule corresponding to given parentIdnr.

Returns:

ScheduleMonitor.Task

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