ScheduleRuleData Class

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

Namespace:  Dundas.BI.WebApi.Models
Assembly:  Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (24.4.0.1000)
Syntax
Copy
[DataContractAttribute]
public class ScheduleRuleData : BaseDataContract

The ScheduleRuleData type exposes the following members.

Constructors
  NameDescription
Public methodScheduleRuleData
Initializes a new instance of the ScheduleRuleData class.
Top
Properties
  NameDescription
Public propertyDailyPatternInterval
Gets or sets the number of repeatable day periods for the schedule.
Public propertyDayOfMonth Obsolete.
Gets or sets the day of the month for the schedule used in a "Day(s) N" pattern.
Public propertyDayOfWeek
Gets or sets the day of the week for the schedule used in a "The [First] [Monday] of [January, February...]" pattern.
Public propertyDaysOfMonth
Gets or sets the days of the month for the schedule used in a "Day(s) N" pattern.
Public propertyDescription
Gets the schedule description.
Public propertyEndDate
Gets or sets the end date for the schedule.
Public propertyEndPolicy
Gets or sets how the schedule ends.
Public propertyFirstOrLastDaysOfMonth
Gets or sets the number of repeatable first or last day periods for the schedule.
Public propertyHasRecurrence
Gets or sets a value indicating whether the schedule has an intra-day recurrence defined.
Public propertyIsDstAdjusted
Gets or sets a value indicating whether the daylight savings time adjustments should be applied.
Public propertyIsEnabled
Gets or sets a value indicating whether the job for this schedule is enabled or not.
Public propertyIsRecurrencePattern
Gets or sets a value indicating whether the recurrence is a pattern, rather than set times.
Public propertyMonthlyPatternKind
Gets or sets whether an ordinal day of the month or specific day of a certain week of a month should be selected.
Public propertyNthSpecificDayOfMonth
Gets or sets the ordinal number of the day in a month.
Public propertyNumberOfOccurrences
Gets or sets the number of occurrences for the schedule.
Public propertyOccurrences
Gets the occurrences - the list of specific running times of the day.
Public propertyPatternType
Gets or sets the type of the schedule pattern.
Public propertyRecurrenceEndTime
Gets or sets the recurrence end time.
Public propertyRecurrenceInterval
Gets or sets the recurrence interval, which could be in hours or minutes, depending on RecurrenceIntervalKind.
Public propertyRecurrenceIntervalKind
Gets or sets the units of the recurrence interval (hours or minutes) in an "Every N [interval]" pattern.
Public propertyRecurrenceStartTime
Gets or sets the recurrence start time.
Public propertySpecificDaysOfWeek
Gets the selected days of the week for the schedule.
Public propertySpecificMonths
Gets the selected months for the schedule used in a "Day N of the following month(s): January, February etc." pattern.
Public propertyStartTime
Gets or sets the start time for the schedule.
Public propertyTimeZoneId
Gets or sets the time zone identifier.
Public propertyUIClassName
Gets or sets the name of the UI class (used for auto de-serialization).
(Inherited from BaseDataContract.)
Public propertyWeeklyPatternInterval
Gets or sets the number of repeatable week periods for the schedule.
Top
Methods
  NameDescription
Public methodCopyToSchedule
Copies properties from the object into a Schedule.
Public methodStatic memberFromDataContractMappings
The mapping between ScheduleRuleData and ScheduleRule.
Public methodStatic memberToDataContractMappings
The mapping between ScheduleRule and ScheduleRuleData.
Top
See Also