Class Condition
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Base class for all Conditions
public abstract class Condition : ADTObject
- Inheritance
-
objectCondition
- Derived
Properties
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
Optional description/notes for the Condition
public string Description { get; set; }
Property Value
- string
DescriptionOverride
public string DescriptionOverride { get; set; }
Property Value
- string
Enabled
public bool Enabled { get; set; }
Property Value
- bool
ExtendedDescription
public override string ExtendedDescription { get; }
Property Value
- string
Name
public string Name { get; set; }
Property Value
- string
PollingInterval
Number of seconds to wait between checks of the condition.
public int PollingInterval { get; set; }
Property Value
- int
Remarks
Set to 0 to use the default polling interval.
StaysTriggered
public bool StaysTriggered { get; set; }
Property Value
- bool
UserInterfaceExtensionData
public string UserInterfaceExtensionData { get; set; }
Property Value
- string
UserInterfaceExtensionID
public string UserInterfaceExtensionID { get; set; }
Property Value
- string
WaitLimit
Number of seconds to wait for the condition to be satisfied.
public int WaitLimit { get; set; }
Property Value
- int
Remarks
Set to 0 for no wait, or -1 for no wait limit (waits until condition is satisfied or job is canceled).
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.
GetConditionDescription()
protected abstract string GetConditionDescription()
Returns
- string
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.EffectivePermissions
- ADTObject.OnNewEntity()
- ADTObject.OnEntityReloaded()
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.CanPerform(SecurityPermission)
- ADTObject.Duplicate()
- ADTObject.CheckForStub(string, string)
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.InitializeFromEntity()
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityActions
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.AddStandardSecurityActions(Dictionary<int, string>, string)
- ADTObject.AddSupportedSecurityAction(Dictionary<int, string>, SecurityPermission, string)
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.IsDependent
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.HideFieldValueInTextOutput(string)
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)