Package com.uc4.communication.requests

Class SaveObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.SaveObject

public class SaveObject
extends XMLRequest

Saves an open UC4 Object.

Constructor Summary

Constructors

Constructor	Description
SaveObject(UC4Object object)	Constructs a SaveObject using a subclass of UC4Object.
SaveObject(UC4Object object, boolean overwrite)	Constructs a SaveObject using a subclass of UC4Object.

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.
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

SaveObject

public SaveObject(UC4Object object)
           throws InvalidObjectException

Constructs a SaveObject using a subclass of UC4Object.

Parameters:

object - an already opened UC4Object

Throws:

InvalidObjectException - Indicates that this UC4 Object failed validation tests

SaveObject

public SaveObject(UC4Object object,
 boolean overwrite)
           throws InvalidObjectException

Constructs a SaveObject using a subclass of UC4Object.

Parameters:

object - an already opened UC4Object

overwrite - overwrite Object

Throws:

InvalidObjectException - Indicates that this UC4 Object failed validation tests

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

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