Class JobGroup
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class JobGroup : ADTIndependentObject
- Inheritance
-
objectJobGroup
Fields
InstanceCounts
public JobInstanceCounts InstanceCounts
Field Value
- JobInstanceCounts
m_GroupCount
public int m_GroupCount
Field Value
- int
m_JobCount
public int m_JobCount
Field Value
- int
m_VisibleGroupCount
public int? m_VisibleGroupCount
Field Value
- int?
m_VisibleJobCount
public int? m_VisibleJobCount
Field Value
- int?
Properties
ActiveJobs
Gets the number of active jobs for the group.
public int? ActiveJobs { get; }
Property Value
- int?
Remarks
This value is only set if the group was fetched through GetJobTree(OID, bool, bool, bool). See InstanceCounts for more information.
- See Also
AssemblyReferences
A semicolon-delimited list of any additional assemblies to be referenced when compiling variable functions used in jobs within this group.
public string AssemblyReferences { get; set; }
Property Value
- string
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
ClassKeyName
The key name for the class.
public override string ClassKeyName { get; }
Property Value
- string
Remarks
This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.
CycleID
The current Cycle ID for this group.
public string CycleID { get; }
Property Value
- string
CycleIDFormat
public string CycleIDFormat { get; set; }
Property Value
- string
CycleIDPrefix
public string CycleIDPrefix { get; set; }
Property Value
- string
CycleIDType
public CycleIDType CycleIDType { get; set; }
Property Value
Description
public string Description { get; set; }
Property Value
- string
ExtendedDescription
public override string ExtendedDescription { get; }
Property Value
- string
FailedJobs
Gets the number of failed jobs for the group.
public int? FailedJobs { get; }
Property Value
- int?
Remarks
This value is only set if the group was fetched through GetJobTree(OID, bool, bool, bool). See InstanceCounts for more information.
- See Also
FullyQualifiedName
Gets the fully-qualified name of the group in the form "level1\level2\level3".
public string FullyQualifiedName { get; }
Property Value
- string
GroupCount
The number of child groups in this group.
public int GroupCount { get; }
Property Value
- int
HoldType
public HoldType HoldType { get; set; }
Property Value
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
IsRootGroup
public bool IsRootGroup { get; }
Property Value
- bool
JobCount
The number of jobs in the group (not including jobs in sub-groups).
public int JobCount { get; }
Property Value
- int
JobVariables
public JobVariableCollection JobVariables { get; }
Property Value
Name
public string Name { get; set; }
Property Value
- string
NamespaceImports
A semicolon-delimited list of any additional namespaces to be included when compiling variable functions used in jobs within this group.
public string NamespaceImports { get; set; }
Property Value
- string
ParentGroup
public JobGroup ParentGroup { get; set; }
Property Value
Responses
Responses to be executed for all jobs in the Group and its subgroups.
public ResponseCollection Responses { get; }
Property Value
ScriptLibraries
public ScriptLibraryCollection ScriptLibraries { get; }
Property Value
SupportedResponseEvents
Gets a list of the events that are supported for Responses associated with this job.
public ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }
Property Value
- ReadOnlyCollection<SupportedResponseEvent>
SupportedSecurityActions
public override Dictionary<int, string> SupportedSecurityActions { get; }
Property Value
- Dictionary<int, string>
SupportedSecurityInheritanceOptions
public override Dictionary<SecurityInheritanceOptions, string> SupportedSecurityInheritanceOptions { get; }
Property Value
- Dictionary<SecurityInheritanceOptions, string>
UseInheritedResponses
Determines whether the Group will use Responses inherited from its paren Group.
public bool UseInheritedResponses { get; set; }
Property Value
- bool
VisibleGroupCount
public int? VisibleGroupCount { get; }
Property Value
- int?
VisibleJobCount
public int? VisibleJobCount { get; }
Property Value
- int?
WarningJobs
Gets the number of jobs with warnings for the group.
public int? WarningJobs { get; }
Property Value
- int?
Remarks
This value is only set if the group was fetched through GetJobTree(OID, bool, bool, bool). See InstanceCounts for more information.
- See Also
Methods
FindOwningObject()
Get the owner of this object based on relationships.
protected override ADTObject FindOwningObject()
Returns
- ADTObject
The owning object, or null if the object is not owned by another object or the owner has not been set.
GetEffectiveHoldType()
Gets the effective HoldType for the group (combining the HoldType for the group and ancestor groups).
public HoldType GetEffectiveHoldType()
Returns
GetGroups(ObjectFetchOptions, bool)
public JobGroupCollection GetGroups(ObjectFetchOptions options, bool refresh)
Parameters
| Name | Type | Description |
|---|---|---|
options |
ObjectFetchOptions | |
refresh |
bool |
Returns
GetGroupsWithPaging(ObjectFetchOptions, int, ref bool)
Gets all child groups for this group, with options.
public JobGroupCollection GetGroupsWithPaging(ObjectFetchOptions options, int pageSize, ref bool restartPaging)
Parameters
| Name | Type | Description |
|---|---|---|
options |
ObjectFetchOptions | Options that control how objects are returned. |
pageSize |
int | Specfies the number of objects to return in each call. Set to 0 to return all objects. See Remarks. |
restartPaging |
bool | On input, indicates whether to start a new paging operation (true) or continue a previous paging operation (false). On return, indicates whether all records have been returned (true) or more records remain (false). See Remarks. |
Returns
Remarks
Calling this method has no effect on the set of groups returned by GetGroups or the Groups property, and vice-versa.
Paging To fetch objects in pages (a maximum number of objects is returned in each request), set the pageSize to the maximum number requested and set restartPaging to true. On return, restartPaging will be false if there are more objects that can be fetched. To fetch the remaining pages of objects, continue to call the method, leaving restartPaging set to false, until restartPaging is true on return. At this point, all available objects have been returned.
GetInheritedVariables(bool)
Gets a collection containing the JobVariables inherited by this object, and optionally the variables for the object itself.
public JobVariableCollection GetInheritedVariables(bool includeSelf)
Parameters
| Name | Type | Description |
|---|---|---|
includeSelf |
bool |
Returns
GetInstanceCounts()
Gets the instance counts for the group.
public InstanceCounts GetInstanceCounts()
Returns
Remarks
This value is only set if the group was fetched through GetJobTree(OID, bool, bool, bool)
GetJobOIDs(SecurityPermission, bool)
Gets the OIDs of all jobs in this group (optionall including subgroups) for which the caller has the specified permission.
public ReadOnlyCollection<OID> GetJobOIDs(SecurityPermission requiredPermission, bool recursive)
Parameters
| Name | Type | Description |
|---|---|---|
requiredPermission |
SecurityPermission | |
recursive |
bool |
Returns
- ReadOnlyCollection<OID>
GetJobs(ObjectFetchOptions, bool)
Gets all jobs for this group that the caller has permission to view.
public JobCollection GetJobs(ObjectFetchOptions options, bool refresh)
Parameters
| Name | Type | Description |
|---|---|---|
options |
ObjectFetchOptions | |
refresh |
bool | If true, the list of jobs is refreshed from the server. If false, the cached set of jobs is returned. |
Returns
Remarks
Jobs are not initially sent from the server. The first time this method is called, they are fetched from the server (regardless of the setting of the refresh parameter). On subsequent calls to this method, the jobs are re-fetched if refresh is True.
Calling this method has no effect on the set of jobs returned by GetJobsWithPaging,
and vice-versa.
- See Also
GetJobsWithPaging(ObjectFetchOptions, int, ref bool)
Gets all jobs for the group, with options.
public JobCollection GetJobsWithPaging(ObjectFetchOptions options, int pageSize, ref bool restartPaging)
Parameters
| Name | Type | Description |
|---|---|---|
options |
ObjectFetchOptions | Options that control how objects are returned. |
pageSize |
int | Specfies the number of objects to return in each call. Set to 0 to return all objects. See Remarks. |
restartPaging |
bool | On input, indicates whether to start a new paging operation (true) or continue a previous paging operation (false). On return, indicates whether all records have been returned (true) or more records remain (false). See Remarks. |
Returns
Remarks
Paging To fetch objects in pages (a maximum number of objects is returned in each request), set the pageSize to the maximum number requested and set restartPaging to true. On return, restartPaging will be false if there are more objects that can be fetched. To fetch the remaining pages of objects, continue to call the method, leaving restartPaging set to false, until restartPaging is true on return. At this point, all available objects have been returned.
GetObjectDescription()
Gets a description of the object's key settings.
protected override string GetObjectDescription()
Returns
- string
Remarks
This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.
- See Also
NewGroup()
Creates a new Job Group within this group.
public JobGroup NewGroup()
Returns
- JobGroup
A new Job Group assigned to the target Group
NewJob()
Creates a new Job within this group.
public Job NewJob()
Returns
- Job
A new Job assigned to the target Group.
UpdateHoldType(HoldType, MissedJobCheckOptions, ChangeLogParameters)
Updates the HoldType for the Group immediately.
public void UpdateHoldType(HoldType newValue, MissedJobCheckOptions missedJobOptions, ChangeLogParameters auditRecord = null)
Parameters
| Name | Type | Description |
|---|---|---|
newValue |
HoldType | The new setting for the object's HoldType |
missedJobOptions |
MissedJobCheckOptions | Indicates how missed executions will be treated if the HoldType.DisableTriggers flag is being turned off. |
auditRecord |
ChangeLogParameters | Optional audit record for change log and snapshot. |
Remarks
This method makes an immediate server call to update the HoldType. No Save is required. The caller must have Modify or Hold/Release permission.
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ADTIndependentObject.Refresh()
- ADTIndependentObject.Revert()
- ADTIndependentObject.Save()
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.Save(out MessageCollection)
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters, out MessageCollection)
- ADTIndependentObject.Delete()
- ADTIndependentObject.DeleteWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.GetSecurityDescriptor()
- ADTIndependentObject.ReplaceObjectReferences(string[], bool, int, IEnumerable<OID>, ADTObject, bool, ChangeLogParameters)
- ADTIndependentObject.GetObjectReferences(string[], bool, int)
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)