Package com.uc4.api.objects
Class ScriptAttributes
java.lang.Object
com.uc4.api.objects.ScriptAttributes
Attributes of SCRI objects.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the deactivate condition for this Job.Returns the setting for extended reports.Returns the internal account assigned to this Script.int
Priority with which this Script should be executed in the Automation Engine.getQueue()
Returns the Queue Object.Returns the start type of this Script.Returns the TimeZone that is to be used.boolean
Returnstrue
if the Script should not be generated at activation time but rather at runtime.Returns settings for parallel tasks.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 Script should be executed in the Automation Engine.void
setQueue
(UC4ObjectName queue) Sets the Queue that will be used when this object is executed.void
setStartType
(UC4ObjectName startType) Sets the start type of this Script.void
setTimezone
(UC4TimezoneName timezone) Sets the TimeZone for this Script.protected void
-
Constructor Details
-
ScriptAttributes
protected ScriptAttributes(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
getQueue
Returns the Queue Object.- Returns:
- Name of the Queue Object
-
setQueue
Sets the Queue that will be used when this object is executed.- Parameters:
queue
- Name of the Queue Object
-
getStartType
Returns the start type of this Script.- Returns:
- start type
-
setStartType
Sets the start type of this Script.- Parameters:
startType
- start type
-
getIntAccount
Returns the internal account assigned to this Script.- Returns:
- internal account
-
setIntAccount
Sets the internal account, max. 20 characters.- Parameters:
intAccount
- internal account
-
maxParallel
Returns settings for parallel tasks.- Returns:
- parallel task settings
-
getPriority
public int getPriority()Priority with which this Script 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 Script 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
-
setTimezone
Sets the TimeZone for this Script.- Parameters:
timezone
- TimeZone
-
isGenerateAtRuntime
public boolean isGenerateAtRuntime()Returnstrue
if the Script should not be generated at activation time but rather at runtime.- Returns:
true
if the Generate at runtime check box is selected
-
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
-
store
-
getDeactivate
Returns the deactivate condition for this Job.- Returns:
- Deactivate condition
-
setDeactivate
Sets the deactivate condition for this Job.- Parameters:
deactivate
- Deactivate condition
-
getExtendedReports
Returns the setting for extended reports.- Returns:
- Extended reports.
-
setExtendedReports
Sets the option for extended reports.- Parameters:
extendedReports
- Extended reports.
-