Table of Contents

Class SharedSchedule

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

Represents a schedule of days that can be shared across multiple jobs

public sealed class SharedSchedule : ADTIndependentObject
Inheritance
object
SharedSchedule

Remarks

The SharedSchedule class is used for both Shared Schedules (UseAsHolidaySet is false) and Holiday Sets (UseAsHolidaySet is true).

A Shared Schedule can be assigned to one ore more Schedules (see Schedule.SharedSchedule rather than using a DateSchedule to define the days on which the job should trigger.

A Holiday Set can be assigned to one or more ScheduleTriggers (ScheduleTrigger.Holidays) to define days on which the job should not trigger.

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.

ClassName

Returns a descriptive name for the class suitable for display to users.

public override string ClassName { get; }

Property Value

string

Remarks

For example, "Job" or "Program Execution Task".

DateCriteria

The rules that define which days this schedule matches

public DateCriterionCollection DateCriteria { get; }

Property Value

DateCriterionCollection

Enabled

Indicates whether the schedule is enabled

public bool Enabled { get; set; }

Property Value

bool

Remarks

If a schedule is disabled it will be ignored when calculating the execution schedules for jobs.

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

The name of the schedule

public string Name { get; set; }

Property Value

string

Remarks

The Name is required an must be unique with the schedule type (Shared Schedule or Holiday Set).

SupportedSecurityActions

List of security actions supported by this object.

public override Dictionary<int, string> SupportedSecurityActions { get; }

Property Value

Dictionary<int, string>

A dictionary of the supported actions. The key is one of the SecurityPermission values and the value is the name of the permission (from GetSecurityPermissionName(SecurityPermission, string); a given SecurityPermission may use different names in different contexts).

UseAsHolidaySet

Indicates whether this schedule is a Holiday Set

public bool UseAsHolidaySet { get; set; }

Property Value

bool

Remarks

See the general Remarks for SharedSchedule

Methods

GetMatchingDates(DateTime, DateTime)

Gets a list of dates that match the schedule

public ReadOnlyCollection<ScheduleMatchDate> GetMatchingDates(DateTime startDate, DateTime endDate)

Parameters

NameTypeDescription
startDate DateTime

The earliest date (inclusive) to consider. The time portion is ignored.
endDate DateTime

The latest date (inclusive) to consider. The time portion is ignored.

Returns

ReadOnlyCollection<ScheduleMatchDate>

A collection of dates that match the rule

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