Class ConditionStatus
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Shows the status of a Condition.
[ComVisible(true)]
[Guid("7b20e90b-80fb-4be3-83c7-1af9542f0a7d")]
public sealed class ConditionStatus : ADTObject
- Inheritance
-
objectConditionStatus
Properties
AdditionalInformation
Additional information about the current status.
public string AdditionalInformation { get; }
Property Value
- string
Remarks
This field may describe things such as the name that a file condition is waiting on, or the name of the file that satisfied the condition.
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.
ConditionDescription
A description of the condition.
public string ConditionDescription { get; }
Property Value
- string
ConditionOID
public Guid ConditionOID { get; }
Property Value
- Guid
ExecutionHistoryItem
The ExecutionHistoryItem representing the job instance to which this status belongs.
public ExecutionHistoryItem ExecutionHistoryItem { get; }
Property Value
ExecutionHistoryStep
The ExecutionHistoryStep representing the job step instance to which this status belongs.
public ExecutionHistoryStep ExecutionHistoryStep { get; }
Property Value
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
Status
The status of the condition
public ConditionState Status { get; }
Property Value
StatusDescription
Gets the text description of the Status.
public string StatusDescription { get; }
Property Value
- string
StepNumber
Gets the step number with which this status is associated.
public int StepNumber { get; }
Property Value
- int
Remarks
Returns 0 if this is a job-level condition (ExecutionHistoryStep is also null)
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.
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
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- 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.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.ExtendedDescription
- 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)