Package com.uc4.api.objects
Class GroupAttributes
java.lang.Object
com.uc4.api.objects.GroupAttributes
JobGroup attributes.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the Queue Object for children of this Group.Returns the deactivate condition for this Job.Returns the setting for extended reports.int
Returns the maximum number of executable objects which are allowed to run simultaneously in a Group.getQueue()
Returns the Queue Object.Returns the TimeZone that is to be used.boolean
Returnstrue
if the JobGroup should not be generated at activation time but rather at runtime.void
setChildrenQueue
(UC4ObjectName childrenQueue) Sets the name of the Queue Object for children of this Group.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
setMaxParallel
(int maxParallel) Specify the maximum number of executable objects which are allowed to run simultaneously in a Group.void
setQueue
(UC4ObjectName queue) Sets the Queue that will be used when this Automic object is executed.void
setTimezone
(UC4TimezoneName timezone) Sets the TimeZone for this job.protected void
-
Constructor Details
-
GroupAttributes
protected GroupAttributes(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
store
-
getMaxParallel
public int getMaxParallel()Returns the maximum number of executable objects which are allowed to run simultaneously in a Group. 0 to 999 tasks are allowed.- Returns:
- Max. parallel tasks
-
setMaxParallel
public void setMaxParallel(int maxParallel) Specify the maximum number of executable objects which are allowed to run simultaneously in a Group. 0 to 999 tasks are allowed.- Parameters:
maxParallel
- Integer between 0 and 999
-
getQueue
Returns the Queue Object.- Returns:
- Name of the Queue Object
-
setQueue
Sets the Queue that will be used when this Automic object is executed.- Parameters:
queue
- Name of the Queue Object
-
getChildrenQueue
Returns the name of the Queue Object for children of this Group.- Returns:
- Name of the Queue or
null
if *OWN has been set.
-
setChildrenQueue
Sets the name of the Queue Object for children of this Group.- Parameters:
childrenQueue
- Name of the Queue (can be empty) ornull
for *OWN
-
getTimezone
Returns the TimeZone that is to be used.- Returns:
- TimeZone
-
setTimezone
Sets the TimeZone for this job.- Parameters:
timezone
- TimeZone
-
isGenerateAtRuntime
public boolean isGenerateAtRuntime()Returnstrue
if the JobGroup 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
-
getExtendedReports
Returns the setting for extended reports.- Returns:
- Extended reports.
-
setExtendedReports
Sets the option for extended reports.- Parameters:
extendedReports
- Extended reports.
-
getDeactivate
Returns the deactivate condition for this Job.- Returns:
- Deactivate condition
-
setDeactivate
Sets the deactivate condition for this Job.- Parameters:
deactivate
- Deactivate condition
-