ScheduleRuleData Class

Base data contract object for returning an ScheduleRule through REST API.

Inheritance Hierarchy

SystemObject
Dundas.BI.WebApi.ModelsBaseDataContract
Dundas.BI.WebApi.ModelsScheduleRuleData

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.3.0.1000)

Syntax

C++

Copy

[DataContractAttribute]
public class ScheduleRuleData : BaseDataContract

<DataContractAttribute>
Public Class ScheduleRuleData
	Inherits BaseDataContract

[DataContractAttribute]
public ref class ScheduleRuleData : public BaseDataContract

[<DataContractAttribute>]
type ScheduleRuleData =  
    class
        inherit BaseDataContract
    end

The ScheduleRuleData type exposes the following members.

Constructors

	Name	Description
	ScheduleRuleData	Initializes a new instance of the ScheduleRuleData class.

Top

Properties

	Name	Description
	DailyPatternInterval	Gets or sets the number of repeatable day periods for the schedule.
	DayOfMonth	Obsolete. Gets or sets the day of the month for the schedule used in a "Day(s) N" pattern.
	DayOfWeek	Gets or sets the day of the week for the schedule used in a "The [First] [Monday] of [January, February...]" pattern.
	DaysOfMonth	Gets or sets the days of the month for the schedule used in a "Day(s) N" pattern.
	Description	Gets the schedule description.
	EndDate	Gets or sets the end date for the schedule.
	EndPolicy	Gets or sets how the schedule ends.
	FirstOrLastDaysOfMonth	Gets or sets the number of repeatable first or last day periods for the schedule.
	HasRecurrence	Gets or sets a value indicating whether the schedule has an intra-day recurrence defined.
	IsDstAdjusted	Gets or sets a value indicating whether the daylight savings time adjustments should be applied.
	IsEnabled	Gets or sets a value indicating whether the job for this schedule is enabled or not.
	IsRecurrencePattern	Gets or sets a value indicating whether the recurrence is a pattern, rather than set times.
	MonthlyPatternKind	Gets or sets whether an ordinal day of the month or specific day of a certain week of a month should be selected.
	NthSpecificDayOfMonth	Gets or sets the ordinal number of the day in a month.
	NumberOfOccurrences	Gets or sets the number of occurrences for the schedule.
	Occurrences	Gets the occurrences - the list of specific running times of the day.
	PatternType	Gets or sets the type of the schedule pattern.
	RecurrenceEndTime	Gets or sets the recurrence end time.
	RecurrenceInterval	Gets or sets the recurrence interval, which could be in hours or minutes, depending on RecurrenceIntervalKind.
	RecurrenceIntervalKind	Gets or sets the units of the recurrence interval (hours or minutes) in an "Every N [interval]" pattern.
	RecurrenceStartTime	Gets or sets the recurrence start time.
	SpecificDaysOfWeek	Gets the selected days of the week for the schedule.
	SpecificMonths	Gets the selected months for the schedule used in a "Day N of the following month(s): January, February etc." pattern.
	StartTime	Gets or sets the start time for the schedule.
	TimeZoneId	Gets or sets the time zone identifier.
	UIClassName	Gets or sets the name of the UI class (used for auto de-serialization). (Inherited from BaseDataContract.)
	WeeklyPatternInterval	Gets or sets the number of repeatable week periods for the schedule.

Top

Methods

	Name	Description
	CopyToSchedule	Copies properties from the object into a Schedule.
	FromDataContractMappings	The mapping between ScheduleRuleData and ScheduleRule.
	ToDataContractMappings	The mapping between ScheduleRule and ScheduleRuleData.

Top

Reference

Dundas.BI.WebApi.Models Namespace