Package com.uc4.api.objects
Class FileTransferAttributes
java.lang.Object
com.uc4.api.objects.FileTransferAttributes
Filetransfer attributes.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FileTransferAttributes
(com.uc4.util.XMLDocument doc) Constructs aJobAttributes
using the specified XML document. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the deactivate condition for this Job.Returns the setting for extended reports.Returns the internal account assigned to this Job.int
Priority with which this Job should be executed in the Automation Engine.getQueue()
Returns the name of the Queue Object.Returns the start type of this Job.Returns the TimeZone that is to be used.boolean
Returnstrue
if the attribut dialog should be displayed when the job is activated.boolean
Returnstrue
if the Job should not be generated at activation time but rather at runtime.Returns settings for parallel tasks.void
setAttributeDialog
(boolean value) Sets or clears the attribut dialog check box.void
setConsumption
(int consumption) Sets the consumption value for this Job.void
setDeactivate
(DeactivateCondition deactivate) Sets the deactivate condition for this Job.void
setExtendedReports
(ExtendedReports extendedReports) Sets the option for extended reports.void
setGenerateAtRuntime
(boolean value) Sets or clears the Generate at runtime check box.void
setIntAccount
(String intAccount) Sets the internal account, max.void
setPriority
(int priority) Priority with which this Job should be executed in the Automation Engine.void
setQueue
(UC4ObjectName queue) Sets the name of the Queue.void
setStartType
(UC4ObjectName startType) Sets the start type of this Job.void
setTimezone
(UC4TimezoneName timezone) Sets the TimeZone for this job.protected void
Stores the content of this job under therequest
element.
-
Constructor Details
-
FileTransferAttributes
protected FileTransferAttributes(com.uc4.util.XMLDocument doc) Constructs aJobAttributes
using the specified XML document.- Parameters:
doc
- XML document
-
-
Method Details
-
getDeactivate
Returns the deactivate condition for this Job.- Returns:
- Deactivate condition
-
setDeactivate
Sets the deactivate condition for this Job.- Parameters:
deactivate
- Deactivate condition
-
getIntAccount
Returns the internal account assigned to this Job.- Returns:
- Internal account
-
getConsumption
public int getConsumption()- Returns:
- The consumption value which is set for this Job.
-
setConsumption
public void setConsumption(int consumption) Sets the consumption value for this Job. The parameterconsumption
must be between 0 and 100000.- Parameters:
consumption
- Consumption
-
getStartType
Returns the start type of this Job.- Returns:
- Start type
-
setIntAccount
Sets the internal account, max. 20 characters.- Parameters:
intAccount
- internal account
-
setStartType
Sets the start type of this Job.- Parameters:
startType
- Start type
-
isAttributeDialog
public boolean isAttributeDialog()Returnstrue
if the attribut dialog should be displayed when the job is activated. The attribut dialog is sent as a READ form. TheINotificationListener
can be used to listen for READ forms.- Returns:
true
if the attribut dialog should be displayed
-
isGenerateAtRuntime
public boolean isGenerateAtRuntime()Returnstrue
if the Job should not be generated at activation time but rather at runtime.- Returns:
true
if the Generate at runtime check box is selected
-
setAttributeDialog
public void setAttributeDialog(boolean value) Sets or clears the attribut dialog check box. ifvalue
istrue
the check box is set.- Parameters:
value
- boolean value indicating if the attribut dialog should be shown
-
maxParallel
Returns settings for parallel tasks.- Returns:
- parallel task settings
-
setGenerateAtRuntime
public void setGenerateAtRuntime(boolean value) Sets or clears the Generate at runtime check box. ifvalue
istrue
the check box is set.- Parameters:
value
- Generate at runtime
-
getPriority
public int getPriority()Priority with which this Job should be executed in the Automation Engine. Permitted values: 0 to 255
Default: 0
1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.- Returns:
- priority
-
setPriority
public void setPriority(int priority) Priority with which this Job should be executed in the Automation Engine. Permitted values: 0 to 255
Default: 0
1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.- Parameters:
priority
- Priority
-
getTimezone
Returns the TimeZone that is to be used.- Returns:
- TimeZone
-
getQueue
Returns the name of the Queue Object.- Returns:
- Queue
-
setQueue
Sets the name of the Queue.- Parameters:
queue
- Queue
-
setTimezone
Sets the TimeZone for this job.- Parameters:
timezone
- TimeZone
-
store
Stores the content of this job under therequest
element.- Parameters:
doc
- XML documentrequest
- the newly created elements are children of therequest
element
-
getExtendedReports
Returns the setting for extended reports.- Returns:
- Extended reports.
-
setExtendedReports
Sets the option for extended reports.- Parameters:
extendedReports
- Extended reports.
-