com.uc4.api.objects

Class FileTransfer

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.FileTransfer

All Implemented Interfaces:

LifecycleSaveAware

public class FileTransfer
extends UC4Object
implements LifecycleSaveAware

This class represents a FileTransfer Object.

Constructor Summary

Constructors

Constructor and Description
FileTransfer()

Method Summary

Modifier and Type	Method and Description
void	afterSaveObject() Called after an object is saved.
FileTransferAttributes	attributes() Returns the generic attributes of this FileTransfer.
java.lang.String	getPostProcess() Returns the content of the Post Process tab.
java.lang.String	getProcess() Returns the content of the "Process" tab.
XHeader	header() Returns the header data of this object.
boolean	isExecutable() Returns true if this Object can be executed.
protected void	loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
OutputScan	outputScan() Returns an OutputScan instance which represents the "Output Scan" tab of a FileTransfer.
Rollback	rollback() This method provides access to the rollback tab of an executable object.
Runtime	runtime() Returns runtime information of this job.
void	setPostProcess(java.lang.String postScript) Sets the content of the Post Process tab.
void	setProcess(java.lang.String script) Sets the content of the "Process" tab.
FileTransferSettings	settings() Settings for the FileTransfer (Source/Destination Hosts, File names, ...) The return value represents the "FileTransfer" tab in the Dialog client.
protected void	storeContent(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo) Stores the object specific data under the objectElement element.
SyncList	syncs() Returns a SyncList object which contains sync conditions of this object.
void	validate() Validates the object.
ObjectValues	values()

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getType, isOldVersion, load, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileTransfer

public FileTransfer()

Method Detail

settings

public FileTransferSettings settings()

Settings for the FileTransfer (Source/Destination Hosts, File names, ...) The return value represents the "FileTransfer" tab in the Dialog client.

Returns:

FileTransfer settings

validate

public void validate()
              throws java.io.InvalidObjectException

Description copied from class: UC4Object

Validates the object. If the object is not valid an InvalidObjectException is thrown.

Overrides:

validate in class UC4Object

Throws:

java.io.InvalidObjectException - If the object is not valid

attributes

public FileTransferAttributes attributes()

Returns the generic attributes of this FileTransfer. The returned object contains all information of the attributes tab.

Returns:

FileTransfer attributes

header

public XHeader header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

syncs

public SyncList syncs()

Returns a SyncList object which contains sync conditions of this object.

Returns:

sync conditions

loadContent

protected void loadContent(com.uc4.util.XMLDocument doc,
                           ConnectionAttributes session)

runtime

public Runtime runtime()

Returns runtime information of this job. This corresponds to the "Runtime" tab in the dialog client.

Returns:

Runtime information

setPostProcess

public void setPostProcess(java.lang.String postScript)

Sets the content of the Post Process tab. The script commands stored in this tab are processed after the Job has ended.

Parameters:

postScript - Post script

getPostProcess

public java.lang.String getPostProcess()

Returns the content of the Post Process tab.

Returns:

Post script

values

public ObjectValues values()

Returns:

Variables of this object

getProcess

public java.lang.String getProcess()

Returns the content of the "Process" tab.

Returns:

JCL

setProcess

public void setProcess(java.lang.String script)

Sets the content of the "Process" tab.

Parameters:

script - Script

outputScan

public OutputScan outputScan()

Returns an OutputScan instance which represents the "Output Scan" tab of a FileTransfer.

Returns:

Output Scan

storeContent

protected void storeContent(com.uc4.util.XMLDocument doc,
                            org.w3c.dom.Element objectElement,
                            ConnectionAttributes sessionInfo)

Description copied from class: UC4Object

Stores the object specific data under the objectElement element.

Parameters:

doc - XML Document, used to create subelements

objectElement - the newly created elements are children of the objectElement element

sessionInfo - Information about the current session

rollback

public Rollback rollback()

This method provides access to the rollback tab of an executable object.

Returns:

Rollback settings

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.

afterSaveObject

public void afterSaveObject()

Description copied from interface: LifecycleSaveAware

Called after an object is saved.

Specified by:

afterSaveObject in interface LifecycleSaveAware