Class JobQueue
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class JobQueue : ADTIndependentObject
- Inheritance
-
objectJobQueue
Properties
ActiveJobs
public int? ActiveJobs { get; }
Property Value
- int?
AgentOptions
public JobAgentOptions AgentOptions { get; set; }
Property Value
Agents
public QueueAgentJoinCollection Agents { get; }
Property Value
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.
Description
public string Description { get; set; }
Property Value
- string
ExtendedDescription
public override string ExtendedDescription { get; }
Property Value
- string
FailedJobs
public int? FailedJobs { get; }
Property Value
- int?
GroupCount
public int? GroupCount { get; }
Property Value
- int?
HoldType
public HoldType HoldType { get; set; }
Property Value
InstanceCounts
public InstanceCounts InstanceCounts { get; }
Property Value
IsDefaultQueue
public bool IsDefaultQueue { get; }
Property Value
- bool
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
JobCount
public int? JobCount { get; }
Property Value
- int?
JobVariables
public JobVariableCollection JobVariables { get; }
Property Value
MaxConcurrentJobs
public int MaxConcurrentJobs { get; set; }
Property Value
- int
MaxDistributedConcurrentJobs
public int MaxDistributedConcurrentJobs { get; set; }
Property Value
- int
Name
public string Name { get; set; }
Property Value
- string
Priority
public int Priority { get; set; }
Property Value
- int
Responses
Responses to be executed for all jobs in the Queue.
public ResponseCollection Responses { get; }
Property Value
ResubmitQueuedOnRestart
public bool ResubmitQueuedOnRestart { get; set; }
Property Value
- bool
RunOnMaster
public bool RunOnMaster { get; set; }
Property Value
- bool
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>
VisibleGroupCount
public int? VisibleGroupCount { get; }
Property Value
- int?
VisibleJobCount
public int? VisibleJobCount { get; }
Property Value
- int?
WarningJobs
public int? WarningJobs { get; }
Property Value
- int?
Methods
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()
public InstanceCounts GetInstanceCounts()
Returns
GetJobs(ObjectFetchOptions, bool)
Gets all jobs for this Queue 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 jobs for the Queue, with control over how objects are returned.
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
UpdateHoldType(HoldType, MissedJobCheckOptions, ChangeLogParameters)
Updates the HoldType for the Queue 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.SupportedSecurityInheritanceOptions
- 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)