Class EffectiveSchedule

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

Represents an effective schedule, used to control when notification recipients, addresses, and group members are acvtive

[ComVisible(true)]
[Guid("9f736a2d-b6e8-4f45-96bc-6fb9b3595edf")]
public sealed class EffectiveSchedule : ADTObject

Inheritance

object

ObjectBase

ADTObject

EffectiveSchedule

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.

EndDate

The latest date this rule applies to

[ComVisible(false)]
public DateTime? EndDate { get; set; }

Property Value

DateTime?

Remarks

The time portion is ignored. See EndTime to restrict the times for this rule.

EndTime

The latest time this rule applies to

[ComVisible(false)]
public DateTime EndTime { get; set; }

Property Value

DateTime

Remarks

Only the time portion of this value is used. It represents the latest time within a day that the rule applies.

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.

NotificationAddress

The NotificationAddress that this rule belongs to, if any

public NotificationAddress NotificationAddress { get; set; }

Property Value

NotificationAddress

NotificationGroupMember

The NotificationGroupMember that this rule belongs to, if any

public NotificationGroupMember NotificationGroupMember { get; set; }

Property Value

NotificationGroupMember

ScheduleType

The type of schedule (include or exclude)

public EffectiveScheduleType ScheduleType { get; set; }

Property Value

EffectiveScheduleType

StartDate

The earliest date this rule applies to

[ComVisible(false)]
public DateTime? StartDate { get; set; }

Property Value

DateTime?

Remarks

The time portion is ignored. See StartTime to restrict the times for this rule.

StartTime

The earliest time this rule applies to

[ComVisible(false)]
public DateTime StartTime { get; set; }

Property Value

DateTime

Remarks

Only the time portion of this value is used. It represents the earliest time within a day that the rule applies.

Weekdays

Specifies the weekdays this rule applies to.

public int Weekdays { get; set; }

Property Value

int

Remarks

This property is a bitmask. Use GetWeekday(Weekday) and SetWeekday(Weekday, bool) to get/set values.

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.

GetWeekday(Weekday)

Determines whether this rule applies to the specified day of the week

public bool GetWeekday(Weekday day)

Parameters

Name	Type	Description
day	Weekday	The day of the week

Returns

bool

GetWeekday(DayOfWeek)

Determines whether this rule applies to the specified day of the week

public bool GetWeekday(DayOfWeek day)

Parameters

Name	Type	Description
day	DayOfWeek	The day of the week

Returns

bool

SetWeekday(Weekday, bool)

Determines whether this rule applies to the specified day of the week

public void SetWeekday(Weekday day, bool selected)

Parameters

Name	Type	Description
day	Weekday	The day of the week
selected	bool	Indicates whether the rule applies to the specified day

SetWeekday(DayOfWeek, bool)

Determines whether this rule applies to the specified day of the week

public void SetWeekday(DayOfWeek day, bool selected)

Parameters

Name	Type	Description
day	DayOfWeek	The day of the week
selected	bool	Indicates whether the rule applies to the specified day

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

Writes the object and any contained objects to a configuration report

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

Name	Type	Description
reportBuilder	IADTObjectConfigurationReportWriter	The report builder to write the object to.

Inherited Members

• ADTObject.LastModified
• ADTObject.CreationTimestamp
• ADTObject.FromController
• ADTObject.CustomProperties
• ADTObject.Description
• ADTObject.DescriptionTextType
• ADTObject.OID
• 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.IsReadOnly
• ObjectBase.IsDirty
• ObjectBase.IsNew
• ObjectBase.IsStub
• ObjectBase.ClassName
• ObjectBase.GetDescriptionWithClassName()
• ObjectBase.GetDescription()
• ObjectBase.BeginEdit()
• ObjectBase.BeginEdit(UndoLevelAction)
• ObjectBase.CommitEdit(Guid)
• ObjectBase.CommitEdit()
• ObjectBase.UndoEdit()
• ObjectBase.UndoEdit(Guid)