Package com.uc4.communication.requests

Class AddJobPlanTask

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.AddJobPlanTask

public class AddJobPlanTask
extends XMLRequest

Returns a JobPlan Task. This request also checks if the task exists in UC4.

Constructor Summary

Constructors

Constructor	Description
AddJobPlanTask(UC4ObjectName objectName)	Constructs a AddJobPlanTask using the specified UC4 Object name.
AddJobPlanTask(UC4ObjectName objectName, UC4Alias alias)	Constructs a AddJobPlanTask using the specified UC4 Object name and alias.

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.
JobPlanTask	getJobPlanTask()	Returns a JobPlan Task or null if the task was not found.
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.
boolean	isExternal()	Returns true if this JobPlanTask is an external task.
void	setExternal(boolean external)	If external is set to true an before the request is sent the UC4 server returns an external JobPlan task.

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

AddJobPlanTask

public AddJobPlanTask(UC4ObjectName objectName)

Constructs a AddJobPlanTask using the specified UC4 Object name.

Parameters:

objectName - Name of the UC4 Object

AddJobPlanTask

public AddJobPlanTask(UC4ObjectName objectName,
                      UC4Alias alias)

Constructs a AddJobPlanTask using the specified UC4 Object name and alias.

Parameters:

objectName - Name of the UC4 Object

alias - Alias

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

isExternal

public boolean isExternal()

Returns true if this JobPlanTask is an external task. The method setExternal can be used to add a task as an external dependency.

Returns:

Boolean indicating if this JobPlanTask is an external task

setExternal

public void setExternal(boolean external)

If external is set to true an before the request is sent the UC4 server returns an external JobPlan task.

Parameters:

external - Boolean containing true if the task should be added as external depencdency

getJobPlanTask

public JobPlanTask getJobPlanTask()

Returns a JobPlan Task or null if the task was not found.

Returns:

Task which can be used in a JobPlan or null

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