Table of Contents

Class Schedule

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll

A Schedule defines rules for when a job should run.

public sealed class Schedule : ADTObject
Inheritance
object
Schedule

Remarks

Each ScheduleTrigger has one or more Schedules defining the days when the job should execute.

The Schedule uses a DateCriterion or SharedSchedule to define the day(s) on which the job should execute, and a TimeCriterion specifying the times.

The ScheduleTrigger may also specify a HolidaySet specifying days on which the job should not execute.

Properties

ClassID

The Class ID for the object

[IgnoreDataMember]
public override ClassID ClassID { get; }

Property Value

ClassID

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.

DateCriterion

The DateCriterion defining the day(s) when the job should execute

public DateCriterion DateCriterion { get; set; }

Property Value

DateCriterion

Remarks

The Schedule must include either a SharedSchedule or a DateCriterion. If SharedSchedule is set, DateCriterion is ignored.

A DateCriterion can only be associated with one Schedule. To use the same settings for more than one Schedule you must either duplicate the DateCriterion or create a SharedSchedule.

See Also

Enabled

Indicates whether the Schedule is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

Disabled schedules are ignored when calculating the execution schedule for a job

IsDependent

Indicates whether the object is a dependent of (owned by) another object

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

Remarks

An independent object (IsDependent is false) is an object that can exist on its own without being part of another object. For example, Jobs, Job Groups, etc.

A dependent object (IsDependent is true) is a part of another object. For example, a JobStep cannot exist independently of a Job, so the JobStep is dependent.

Dependent objects cannot be directly fetched from the server: they are only fetched as part of the object they belong to. They also cannot be saved or deleted independently: they are automatically saved or deleted when the owning object is saved or deleted.

Name

Optional name for the schedule

public string Name { get; set; }

Property Value

string

SharedSchedule

The SharedSchedule defining the day(s) when the job should execute

public SharedSchedule SharedSchedule { get; set; }

Property Value

SharedSchedule

Remarks

The Schedule must include either a SharedSchedule or a DateCriterion. If SharedSchedule is set, DateCriterion is ignored.

The SharedSchedule can be associated with more than one Schedule.

See Also

TimeCriterion

Specifies the time(s) at which the job should execute

public TimeCriterion TimeCriterion { get; set; }

Property Value

TimeCriterion

Remarks

A TimeCriterion can only be associated with one Schedule. To use the same time settings with another Schedule you must duplicate the TimeCriterion.

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.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

The report builder to write the object to.

Inherited Members