Class Job
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class Job : ADTIndependentObject
- Inheritance
-
objectJob
Properties
APIExtensionData
public string APIExtensionData { get; set; }
Property Value
- string
APITags
public StringList APITags { get; }
Property Value
AgentType
public int AgentType { get; set; }
Property Value
- int
AlreadyRunningBehavior
public AlreadyRunningBehavior AlreadyRunningBehavior { get; set; }
Property Value
AssemblyReferences
A semicolon-delimited list of any additional assemblies to be referenced when compiling variable functions used in this job.
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.
ConditionFailureAction
public ConditionFailureOptions ConditionFailureAction { get; set; }
Property Value
ConditionRule
public ConditionRule ConditionRule { get; set; }
Property Value
ConditionScript
public Script ConditionScript { get; set; }
Property Value
Conditions
public ConditionCollection Conditions { get; }
Property Value
Credentials
public CredentialProfile Credentials { get; set; }
Property Value
Description
public string Description { get; set; }
Property Value
- string
DescriptionOverride
public string DescriptionOverride { get; set; }
Property Value
- string
ExtendedDescription
public override string ExtendedDescription { get; }
Property Value
- string
FullyQualifiedName
public string FullyQualifiedName { get; }
Property Value
- string
Group
public JobGroup Group { get; set; }
Property Value
HistoryRetentionLimit
public int HistoryRetentionLimit { get; set; }
Property Value
- int
HistoryRetentionOptions
public HistoryRetentionOptions HistoryRetentionOptions { get; set; }
Property Value
HoldType
public HoldType HoldType { get; set; }
Property Value
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
JobQueue
public JobQueue JobQueue { get; set; }
Property Value
JobStatus
public JobStatus JobStatus { get; }
Property Value
JobVariables
public JobVariableCollection JobVariables { get; }
Property Value
LogRetention
public int LogRetention { get; set; }
Property Value
- int
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 this job.
public string NamespaceImports { get; set; }
Property Value
- string
Priority
public int Priority { get; set; }
Property Value
- int
RemoteAgents
public JobAgentJoinCollection RemoteAgents { get; }
Property Value
ResourceFailureAction
public ResourceFailureAction ResourceFailureAction { get; set; }
Property Value
ResourceWaitLimit
public int ResourceWaitLimit { get; set; }
Property Value
- int
Resources
public ResourceCollection Resources { get; }
Property Value
Responses
public ResponseCollection Responses { get; }
Property Value
RestartOptions
public RestartOptions RestartOptions { get; set; }
Property Value
RunElevated
public bool RunElevated { get; set; }
Property Value
- bool
ScriptLibraries
public ScriptLibraryCollection ScriptLibraries { get; }
Property Value
StepExecutionRule
public StepExecutionSequence StepExecutionRule { get; set; }
Property Value
Steps
public JobStepCollection Steps { get; }
Property Value
SupportedResponseEvents
public ReadOnlyCollection<SupportedResponseEvent> SupportedResponseEvents { get; }
Property Value
- ReadOnlyCollection<SupportedResponseEvent>
SupportedSecurityActions
public override Dictionary<int, string> SupportedSecurityActions { get; }
Property Value
- Dictionary<int, string>
Tags
public StringList Tags { get; }
Property Value
TagsList
Gets or sets the list of tags as a comma-delimited string.
public string TagsList { get; set; }
Property Value
- string
Triggers
public TriggerCollection Triggers { get; }
Property Value
UpdateCycleID
public bool UpdateCycleID { get; set; }
Property Value
- bool
UseInheritedResponses
public bool UseInheritedResponses { get; set; }
Property Value
- bool
UserInteractionMode
public UserInteractionMode UserInteractionMode { get; set; }
Property Value
UserInterfaceExtensionData
public string UserInterfaceExtensionData { get; set; }
Property Value
- string
UserInterfaceExtensionID
public string UserInterfaceExtensionID { get; set; }
Property Value
- string
WaitStartLimit
public int WaitStartLimit { get; set; }
Property Value
- int
Methods
ClearHistory(HistoryClearOptions)
Clears the history for the job, optionally resetting the statistics for the job.
public void ClearHistory(HistoryClearOptions options)
Parameters
| Name | Type | Description |
|---|---|---|
options |
HistoryClearOptions |
Remarks
Calling this method initiates an immediate purchase of the history data for the job.
Execute(JobExecutionSettings)
public ExecuteJobResult Execute(JobExecutionSettings options)
Parameters
| Name | Type | Description |
|---|---|---|
options |
JobExecutionSettings |
Returns
GetEffectiveHoldType()
Gets the effective HoldType for the job (combining the HoldType for the job, queue, and group hierarchy).
public HoldType GetEffectiveHoldType()
Returns
GetExecutionHistory(InstanceQueryParameters)
public ExecutionHistoryItemCollection GetExecutionHistory(InstanceQueryParameters parameters)
Parameters
| Name | Type | Description |
|---|---|---|
parameters |
InstanceQueryParameters |
Returns
GetHistoryAndMessages(InstanceQueryParameters, out ExecutionHistoryItemCollection, LogQueryParameters, out LogMessageCollection)
public void GetHistoryAndMessages(InstanceQueryParameters historyParameters, out ExecutionHistoryItemCollection history, LogQueryParameters logParameters, out LogMessageCollection messages)
Parameters
| Name | Type | Description |
|---|---|---|
historyParameters |
InstanceQueryParameters | |
history |
ExecutionHistoryItemCollection | |
logParameters |
LogQueryParameters | |
messages |
LogMessageCollection |
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
GetJobChain(Guid?)
Gets all jobs in the chain that contains this job.
public JobLinkResults GetJobChain(Guid? chainID)
Parameters
| Name | Type | Description |
|---|---|---|
chainID |
Guid? | If specified, only jobs participating in the specified chain are returned. |
Returns
Remarks
GetJobChain returns all jobs that are linked to this job, directly or indirectly, through JobConditions and JobControlActions.
For example, if this job is called by a Response in JobA, and JobA has a condition on JobB, GetJobChain returns this job, JobA, and JobB.
GetLogMessages(LogQueryParameters)
public LogMessageCollection GetLogMessages(LogQueryParameters parameters)
Parameters
| Name | Type | Description |
|---|---|---|
parameters |
LogQueryParameters |
Returns
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
GetStandardSupportedResponseEvents()
public static List<SupportedResponseEvent> GetStandardSupportedResponseEvents()
Returns
- List<SupportedResponseEvent>
GetStatus(bool)
public JobStatus GetStatus(bool Refresh = false)
Parameters
| Name | Type | Description |
|---|---|---|
Refresh |
bool |
Returns
GetTriggerStatus(OID)
Gets the TriggerStatus for the job or for a specified trigger.
public TriggerStatusCollection GetTriggerStatus(OID triggerOID)
Parameters
| Name | Type | Description |
|---|---|---|
triggerOID |
OID | The trigger to get the status for. Specify null (Nothing) to get the status for all triggers. |
Returns
Remarks
Requires ServerFeatureLevel 40301 or higher. Note that not all triggers report status information.
IsFromMaster()
public bool IsFromMaster()
Returns
- bool
OnEntityReloaded()
Called when the entity is reloaded from a DTO.
protected override void OnEntityReloaded()
OnNewEntity()
Called when a new entity is created.
protected override void OnNewEntity()
Resync(int)
Resynchronizes status data for the job.
public void Resync(int options)
Parameters
| Name | Type | Description |
|---|---|---|
options |
int | Reserved for future use. |
Remarks
Use this method to initiate a resync if the instance counts for the job are incorrect.
Terminate(TerminationOptions, int)
public void Terminate(TerminationOptions options, int instanceID)
Parameters
| Name | Type | Description |
|---|---|---|
options |
TerminationOptions | |
instanceID |
int |
UpdateHoldType(HoldType, MissedJobCheckOptions, ChangeLogParameters)
Updates the HoldType for the Job 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)