Package com.uc4.communication.requests

Class ActivateObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ActivateObject

public class ActivateObject
extends XMLRequest

Sets an object active or inactive.

Constructor Summary

Constructors

Constructor	Description
ActivateObject(UC4ObjectName name)	Toggles the active state of the given object.
ActivateObject(java.util.List<UC4ObjectName> names)	Toggles the active state of the given objects.

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 java.lang.String	getSrc()	Returns the request source.
protected boolean	isAllowedInClientZero()	This method is used internally.
void	setActive(boolean active)	Sets the active state exclusively (no toggle) to the state which is passed.

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, handleContent, 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

ActivateObject

public ActivateObject(UC4ObjectName name)

Toggles the active state of the given object.

Parameters:

name - name of object which state should be toggled.

ActivateObject

public ActivateObject(java.util.List<UC4ObjectName> names)

Toggles the active state of the given objects.

Parameters:

names - names of objects which state should be toggled.

Method Detail

setActive

public void setActive(boolean active)

Sets the active state exclusively (no toggle) to the state which is passed.

Parameters:

active - sets the object(s) to active if true.

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

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