Package com.uc4.communication.requests

Class GetExecutePeriod

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetExecutePeriod

public class GetExecutePeriod
extends XMLRequest

Reads Properties of a periodical Task.

Constructor Summary

Constructors

Constructor	Description
GetExecutePeriod(int runID)	Constructs a new GetExecutePeriod request.
GetExecutePeriod(UC4ObjectName objectname)	Constructs a new GetExecutePeriod 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.
ExecuteRecurring	getExecuteRecurring()	Returns ExecuteRecurring of the periodical task.
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.
void	setActivityRecurringExecute()	If this method is called the detail of a task in the activity list is returned.
void	setArchiveRecurringExecute()	If this method is called the detail of a task in the statistics is returned.
void	setExplorerRecurringExecute()	If this method is called the detail of a task in the Explorer is returned.

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

GetExecutePeriod

public GetExecutePeriod(int runID)

Constructs a new GetExecutePeriod request.

Parameters:

runID - RunID

GetExecutePeriod

public GetExecutePeriod(UC4ObjectName objectname)

Constructs a new GetExecutePeriod request.

Parameters:

objectname - Name of the object.

Method Details

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

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

getExecuteRecurring

public ExecuteRecurring getExecuteRecurring()

Returns ExecuteRecurring of the periodical task.

Returns:

ExecuteRecurring

setActivityRecurringExecute

public void setActivityRecurringExecute()

If this method is called the detail of a task in the activity list is returned.

setArchiveRecurringExecute

public void setArchiveRecurringExecute()

If this method is called the detail of a task in the statistics is returned.

setExplorerRecurringExecute

public void setExplorerRecurringExecute()

If this method is called the detail of a task in the Explorer is returned.