Package com.uc4.communication.requests

Class ExportWithReferences

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ExportWithReferences

public class ExportWithReferences
extends XMLRequest

Exports an object and all its referenced objects. For example when a workflow is exported all sub tasks are also exported.

Since:

V11.2

Constructor Summary

Constructors

Constructor	Description
ExportWithReferences(UC4ObjectName name, File exportFile)	Creates a new request to export an object with all referenced objects.

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.
ByteBuffer	getBinaryContent()	Returns the export file content as ByteBuffer.
Exception	getExportException()	Returns the Exception that occurred during the export or null if the export was successful.
String	getExportMessages()	Returns export messages.
Iterator<DownloadBinary>	getResourceList()	Returns an Iterator with items of DownloadBinary objects after invoking the ExportObject instance.
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.
boolean	wasSuccessful()	Returns true if the file was saved successfully.

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

ExportWithReferences

public ExportWithReferences(UC4ObjectName name,
 File exportFile)

Creates a new request to export an object with all referenced objects.

Parameters:

name - Name of the Object

exportFile - Name of the export file

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

getExportMessages

public String getExportMessages()

Returns export messages. This method returns an empty String if there are no messages

Returns:

String containing export log messages, never null

wasSuccessful

public boolean wasSuccessful()

Returns true if the file was saved successfully. If this method returns false the method getExportException can be used to get the exception which occured during the export.

Returns:

True if the objects where successfully exported

getExportException

public Exception getExportException()

Returns the Exception that occurred during the export or null if the export was successful.

Returns:

Export exception or null

getBinaryContent

public ByteBuffer getBinaryContent()

Returns the export file content as ByteBuffer.

Returns:

file content

getResourceList

public Iterator<DownloadBinary> getResourceList()

Returns an Iterator with items of DownloadBinary objects after invoking the ExportObject instance. Use this Iterator to additionally download all related resource items of each STORE object containing within the export.

Returns:

An Iterator containing all resource items of each exported STORE object.