public class ExportWithReferences extends XMLRequest
Constructor and Description |
---|
ExportWithReferences(UC4ObjectName name,
java.io.File exportFile)
Creates a new request to export an object with all referenced objects.
|
Modifier and Type | Method and Description |
---|---|
protected void |
createRequest(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element request,
ConnectionAttributes sessionInfo)
Creates the XML Document for the request.
|
java.nio.ByteBuffer |
getBinaryContent()
Returns the export file content as
ByteBuffer . |
java.lang.Exception |
getExportException()
Returns the
Exception that occurred during the export or null
if the export was successful. |
java.lang.String |
getExportMessages()
Returns export messages.
|
java.util.Iterator<DownloadBinary> |
getResourceList()
|
protected java.lang.String |
getSrc()
Returns the request source.
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
boolean |
wasSuccessful()
Returns
true if the file was saved successfully. |
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
public ExportWithReferences(UC4ObjectName name, java.io.File exportFile)
name
- Name of the ObjectexportFile
- Name of the export fileprotected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionprotected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
protected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwisepublic java.lang.String getExportMessages()
public boolean wasSuccessful()
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.public java.lang.Exception getExportException()
Exception
that occurred during the export or null
if the export was successful.public java.nio.ByteBuffer getBinaryContent()
ByteBuffer
.public java.util.Iterator<DownloadBinary> getResourceList()
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.Iterator
containing all resource items of each exported STORE object.