Class TimeCriterion
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
public sealed class TimeCriterion : ADTObject
- Inheritance
-
objectTimeCriterion
Properties
AllowEarlyStart
Determines whether the job can start early when the StartWithin period is set
public bool AllowEarlyStart { get; set; }
Property Value
- bool
- See Also
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.
CriterionType
public TimeCriterionType CriterionType { get; set; }
Property Value
EndTime
[ComVisible(false)]
public DateTime? EndTime { get; set; }
Property Value
- DateTime?
Interval
public int Interval { get; set; }
Property Value
- int
IntervalType
public DayTimeInterval IntervalType { get; set; }
Property Value
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
Schedule
public Schedule Schedule { get; set; }
Property Value
StartTime
[ComVisible(false)]
public DateTime? StartTime { get; set; }
Property Value
- DateTime?
StartWithin
Specifies a window of time (in seconds) within the job should start.
public int StartWithin { get; set; }
Property Value
- int
Remarks
If StartWithin is 0 (the default) adTempus starts the job as close to the exact scheduled start time as possible. If StartWithin is set to a positive value, it indicates that the job should start within StartsWithin seconds of the scheduled execution time. adTempus will randomly select a start time within that window. If AllowEarlyStart is True, the job may start up to StartWithin seconds before the specified start time.
Times
public ICollection<DateTime> Times { get; }
Property Value
- ICollection<DateTime>
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)