Package com.uc4.api.objects
Class FileTransfer
java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.FileTransfer
- All Implemented Interfaces:
LifecycleSaveAware
This class represents a FileTransfer Object.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Called after an object is saved.Returns the generic attributes of this FileTransfer.Returns the content of the Post Process tab.Returns the content of the "Process" tab.header()
Returns the header data of this object.boolean
Returnstrue
if this Object can be executed.protected void
loadContent
(com.uc4.util.XMLDocument doc, ConnectionAttributes session) Returns anOutputScan
instance which represents the "Output Scan" tab of a FileTransfer.rollback()
This method provides access to the rollback tab of an executable object.runtime()
Returns runtime information of this job.void
setPostProcess
(String postScript) Sets the content of the Post Process tab.void
setProcess
(String script) Sets the content of the "Process" tab.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, Element objectElement, ConnectionAttributes sessionInfo) syncs()
Returns aSyncList
object which contains sync conditions of this object.void
validate()
Validates the object.values()
Methods inherited from class com.uc4.api.objects.UC4Object
docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store
-
Constructor Details
-
FileTransfer
public FileTransfer()
-
-
Method Details
-
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
Description copied from class:UC4Object
Validates the object. If the object is not valid anInvalidObjectException
is thrown.- Overrides:
validate
in classUC4Object
- Throws:
InvalidObjectException
- If the object is not valid
-
attributes
Returns the generic attributes of this FileTransfer. The returned object contains all information of the attributes tab.- Returns:
- FileTransfer attributes
-
header
Returns the header data of this object. This is the information of the header tab in the dialog client.- Returns:
- header
-
syncs
Returns aSyncList
object which contains sync conditions of this object.- Returns:
- sync conditions
-
loadContent
-
runtime
Returns runtime information of this job. This corresponds to the "Runtime" tab in the dialog client.- Returns:
- Runtime information
-
setPostProcess
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
Returns the content of the Post Process tab.- Returns:
- Post script
-
values
- Returns:
- Variables of this object
-
getProcess
Returns the content of the "Process" tab.- Returns:
- JCL
-
setProcess
Sets the content of the "Process" tab.- Parameters:
script
- Script
-
outputScan
Returns anOutputScan
instance which represents the "Output Scan" tab of a FileTransfer.- Returns:
- Output Scan
-
storeContent
protected void storeContent(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes sessionInfo) -
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
Returnstrue
if this Object can be executed.- Specified by:
isExecutable
in classUC4Object
- 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 interfaceLifecycleSaveAware
-