Bexel.Api.Scheduling.Calendar Class Reference

Represents working and non-working time periods for tasks and resources. More...

Inheritance diagram for Bexel.Api.Scheduling.Calendar:

Public Member Functions
IEnumerable< DateTime >	GetWorkingHours (DateTime startDate, DateTime finishDate)
	Returns a collection of all working hours of the time period. More...
IEnumerable< DateTime >	GetWorkingDays (DateTime startDate, DateTime finishDate)
	Returns a collection of all working days of the time period. More...
DateTime	GetFirstWorkingHour (DateTime date)
	Returns first working hour which is greater or equal to a specified date. More...
DateTime	GetLastWorkingHour (DateTime date)
	Returns last working hour which is less than or equal to a specified date. More...
DateTime	AddWorkingHours (DateTime date, int count)
	Returns a working hour computed from the addition of a specified date and working hours count. More...
Public Member Functions inherited from Bexel.Api.IdentifiableApiObject< CalendarID >
bool	Equals (IdentifiableApiObject< TId > other)
override bool	Equals (object obj)
override int	GetHashCode ()

Properties
override CalendarID	ID [get]
	Returns a unique identifier for the calendar within a single schedule. More...
Schedule	Schedule [get]
	Returns the schedule to which the calendar belongs. More...
override bool	IsValid [get]
string	Name [get]
	Returns the name of the calendar. More...
bool	Default [get]
	Indicates if the calendar is the default for the schedule to which belongs. More...
CalendarDailyWorkingHours	DailyWorkingHours [get]
	Returns a collection of all daily working hours within the calendar. More...
IReadOnlyDictionary< CalendarExceptionID, CalendarException >	Exceptions [get]
	Returns a collection of all calendar exceptions within the calendar. More...
Properties inherited from Bexel.Api.IdentifiableApiObject< CalendarID >
abstract TId	ID [get]

Additional Inherited Members
Static Public Member Functions inherited from Bexel.Api.IdentifiableApiObject< CalendarID >
static bool	operator== (IdentifiableApiObject< TId > left, IdentifiableApiObject< TId > right)
static bool	operator!= (IdentifiableApiObject< TId > left, IdentifiableApiObject< TId > right)

Detailed Description

Represents working and non-working time periods for tasks and resources.

Member Function Documentation

AddWorkingHours()

DateTime Bexel.Api.Scheduling.Calendar.AddWorkingHours	(	DateTime	date,
		int	count
	)

Returns a working hour computed from the addition of a specified date and working hours count.

Parameters

date	The date value to add.
count	A number of working hours.

Returns

A working hour computed from the addition of a specified date and working hours count.

GetFirstWorkingHour()

DateTime Bexel.Api.Scheduling.Calendar.GetFirstWorkingHour

(

DateTime

date

)

Returns first working hour which is greater or equal to a specified date.

Parameters

date	Date and time value.

Returns

First working hour which is greater or equal to a specified date.

GetLastWorkingHour()

DateTime Bexel.Api.Scheduling.Calendar.GetLastWorkingHour

(

DateTime

date

)

Returns last working hour which is less than or equal to a specified date.

Parameters

date	Date and time value.

Returns

Last working hour which is less than or equal to a specified date.

GetWorkingDays()

IEnumerable<DateTime> Bexel.Api.Scheduling.Calendar.GetWorkingDays	(	DateTime	startDate,
		DateTime	finishDate
	)

Returns a collection of all working days of the time period.

Parameters

startDate	Start date of the period.
finishDate	Finish date of the period.

Returns

All the working days of the time period.

GetWorkingHours()

IEnumerable<DateTime> Bexel.Api.Scheduling.Calendar.GetWorkingHours	(	DateTime	startDate,
		DateTime	finishDate
	)

Returns a collection of all working hours of the time period.

Parameters

startDate	Start date of the period.
finishDate	Finish date of the period.

Returns

All the working hours of the time period.

Property Documentation

DailyWorkingHours

CalendarDailyWorkingHours Bexel.Api.Scheduling.Calendar.DailyWorkingHours

get

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

Default

bool Bexel.Api.Scheduling.Calendar.Default

get

Indicates if the calendar is the default for the schedule to which belongs.

Exceptions

IReadOnlyDictionary<CalendarExceptionID, CalendarException> Bexel.Api.Scheduling.Calendar.Exceptions

get

Returns a collection of all calendar exceptions within the calendar.

ID

override CalendarID Bexel.Api.Scheduling.Calendar.ID

get

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

Name

string Bexel.Api.Scheduling.Calendar.Name

get

Returns the name of the calendar.

Schedule

Schedule Bexel.Api.Scheduling.Calendar.Schedule

get

Returns the schedule to which the calendar belongs.