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

Represents a schedule (collection) of Bexel.Api.Scheduling.Tasks. More...

Inheritance diagram for Bexel.Api.Scheduling.Schedule:
Bexel.Api.IdentifiableApiObject< ScheduleID >

Public Member Functions

void Update ()
 Updates the schedule (linked elements, cost, time, task hierarchy, etc.) and ensures the schedule is up to date with the current project state. More...
 
- Public Member Functions inherited from Bexel.Api.IdentifiableApiObject< ScheduleID >
bool Equals (IdentifiableApiObject< TId > other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Properties

override ScheduleID ID [get]
 Returns a unique identifier for the schedule within a single project. More...
 
Project Project [get]
 Returns the project in which the schedule resides. More...
 
override bool IsValid [get]
 
string Name [get]
 Returns the name of the schedule. More...
 
string Description [get]
 Returns the description of the schedule. More...
 
CostVersion CostVersion [get]
 Returns a cost version to which the schedule is connected. More...
 
IScheduleTasks Tasks [get]
 Returns a collection of all Bexel.Api.Scheduling.Tasks that are contained within the schedule. More...
 
Schedule Baseline [get]
 Returns a baseline schedule of the schedule. More...
 
IReadOnlyDictionary< CalendarID, CalendarCalendars [get]
 Returns a collection of all Bexel.Api.Scheduling.Calendars that are contained within the schedule. More...
 
DateTime RemainingStartDate [get]
 Returns the remaining start date of the schedule. All uncompleted work is scheduled on or after the remaining start date. More...
 
ScheduleTaskPropertyDefinitions PropertyDefinitions [get]
 Returns a collection of all Bexel.Api.Scheduling.TaskPropertyDefinitions that are contained within the schedule. More...
 
- Properties inherited from Bexel.Api.IdentifiableApiObject< ScheduleID >
abstract TId ID [get]
 

Additional Inherited Members

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

Detailed Description

Represents a schedule (collection) of Bexel.Api.Scheduling.Tasks.

Member Function Documentation

◆ Update()

void Bexel.Api.Scheduling.Schedule.Update ( )

Updates the schedule (linked elements, cost, time, task hierarchy, etc.) and ensures the schedule is up to date with the current project state.

Property Documentation

◆ Baseline

Schedule Bexel.Api.Scheduling.Schedule.Baseline
get

Returns a baseline schedule of the schedule.

◆ Calendars

IReadOnlyDictionary<CalendarID, Calendar> Bexel.Api.Scheduling.Schedule.Calendars
get

Returns a collection of all Bexel.Api.Scheduling.Calendars that are contained within the schedule.

◆ CostVersion

CostVersion Bexel.Api.Scheduling.Schedule.CostVersion
get

Returns a cost version to which the schedule is connected.

◆ Description

string Bexel.Api.Scheduling.Schedule.Description
get

Returns the description of the schedule.

◆ ID

override ScheduleID Bexel.Api.Scheduling.Schedule.ID
get

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

◆ Name

string Bexel.Api.Scheduling.Schedule.Name
get

Returns the name of the schedule.

◆ Project

Project Bexel.Api.Scheduling.Schedule.Project
get

Returns the project in which the schedule resides.

◆ PropertyDefinitions

ScheduleTaskPropertyDefinitions Bexel.Api.Scheduling.Schedule.PropertyDefinitions
get

Returns a collection of all Bexel.Api.Scheduling.TaskPropertyDefinitions that are contained within the schedule.

◆ RemainingStartDate

DateTime Bexel.Api.Scheduling.Schedule.RemainingStartDate
get

Returns the remaining start date of the schedule. All uncompleted work is scheduled on or after the remaining start date.

◆ Tasks

IScheduleTasks Bexel.Api.Scheduling.Schedule.Tasks
get

Returns a collection of all Bexel.Api.Scheduling.Tasks that are contained within the schedule.