Package com.uc4.api.objects
Class OutputScan
java.lang.Object
com.uc4.api.objects.OutputScan
This class represents the Output-Scan tab in AE-Object definitions.
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedOutputScan(com.uc4.util.XMLDocument doc) Constructs aOutputScanusing the specified XML document -
Method Summary
Modifier and TypeMethodDescriptionAccess to the list of Output-Scan filters.getHost()Returns the name of the Agent which is used for external file scans.Returns anenumwhich describes if the scan should affect child jobs.getLogin()Returns the name of the login object which is used for external file scans.voidsetHost(UC4HostName host) Sets the name of the Agent which is used for external file scans.voidsetInherit(OutputScan.Inherit inherit) Sets anenumwhich describes if the scan should affect child jobs.voidsetLogin(UC4ObjectName login) Sets the login object for the specified host.protected voidStores data of this object under therequestelement.
-
Constructor Details
-
OutputScan
protected OutputScan(com.uc4.util.XMLDocument doc) Constructs aOutputScanusing the specified XML document- Parameters:
doc- XML Document
-
-
Method Details
-
store
Stores data of this object under therequestelement.- Parameters:
doc- XML Documentrequest- root element, the header is stored in children elements ofrequest
-
getInherit
Returns anenumwhich describes if the scan should affect child jobs.- Returns:
- Inherit scan to reports of child jobs
-
setInherit
Sets anenumwhich describes if the scan should affect child jobs.- Parameters:
inherit- Inherit scan to reports of child jobs
-
getHost
Returns the name of the Agent which is used for external file scans.- Returns:
- Name of the UC4 HOST object
-
setHost
Sets the name of the Agent which is used for external file scans. The parameterhostcan benullor an empty UC4HostName instance if no host should be set in this Output-Scan definition- Parameters:
host- Name of the HOST object or null
-
getLogin
Returns the name of the login object which is used for external file scans.- Returns:
- Login Object
-
filterList
Access to the list of Output-Scan filters. The return value may be modified by the methods of the List interface.- Returns:
- Output-Scan filter
-
setLogin
Sets the login object for the specified host.- Parameters:
login- Name of an existing login Object
-