Bexel Manager API Documentation
Bexel.Api.Scheduling.CalendarException Class Reference

Represents altered work times that occur on a regular schedule. (e.g. every week, every month, every second year). More...

Inheritance diagram for Bexel.Api.Scheduling.CalendarException:
Bexel.Api.IdentifiableApiObject< CalendarExceptionID >

Public Member Functions

IEnumerable< DateTime > GetOccurrences ()
 Returns a collection of all occurrences of a calendar exception. More...
 
- Public Member Functions inherited from Bexel.Api.IdentifiableApiObject< CalendarExceptionID >
bool Equals (IdentifiableApiObject< TId > other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Properties

override CalendarExceptionID ID [get]
 Returns a unique identifier for the calendar exception within a single schedule. More...
 
override bool IsValid [get]
 
string Name [get]
 Returns the name of the calendar exception. More...
 
IEnumerable< int > WorkingHours [get]
 Returns a collection of all working hours within the calendar exception. More...
 
DateTime StartDate [get]
 Returns the start date of the calendar exception. More...
 
DateTime FinishDate [get]
 Returns the finish date of the calendar exception. More...
 
- Properties inherited from Bexel.Api.IdentifiableApiObject< CalendarExceptionID >
abstract TId ID [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from Bexel.Api.IdentifiableApiObject< CalendarExceptionID >
static bool operator== (IdentifiableApiObject< TId > left, IdentifiableApiObject< TId > right)
 
static bool operator!= (IdentifiableApiObject< TId > left, IdentifiableApiObject< TId > right)
 

Detailed Description

Represents altered work times that occur on a regular schedule. (e.g. every week, every month, every second year).

Member Function Documentation

◆ GetOccurrences()

IEnumerable<DateTime> Bexel.Api.Scheduling.CalendarException.GetOccurrences ( )

Returns a collection of all occurrences of a calendar exception.

Returns
All occurrences of a calendar exception.

Property Documentation

◆ FinishDate

DateTime Bexel.Api.Scheduling.CalendarException.FinishDate
get

Returns the finish date of the calendar exception.

◆ ID

override CalendarExceptionID Bexel.Api.Scheduling.CalendarException.ID
get

Returns a unique identifier for the calendar exception within a single schedule.

◆ Name

string Bexel.Api.Scheduling.CalendarException.Name
get

Returns the name of the calendar exception.

◆ StartDate

DateTime Bexel.Api.Scheduling.CalendarException.StartDate
get

Returns the start date of the calendar exception.

◆ WorkingHours

IEnumerable<int> Bexel.Api.Scheduling.CalendarException.WorkingHours
get

Returns a collection of all working hours within the calendar exception.