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

Represents an identifiable unit of work to be carried out in a construction project. More...

Inheritance diagram for Bexel.Api.Scheduling.Task:
Bexel.Api.IdentifiableApiObject< TaskID >

Public Member Functions

IEnumerable< TaskGetAllChildren ()
 Returns a collection of all child tasks that are contained within the task and it's subtasks. More...
 
IEnumerable< TaskGetAllChildrenIncludingSelf ()
 Returns a collection of all child tasks that are contained within the task and it's subtasks, including itself. More...
 
- Public Member Functions inherited from Bexel.Api.IdentifiableApiObject< TaskID >
bool Equals (IdentifiableApiObject< TId > other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Properties

override TaskID ID [get]
 Returns a unique identifier for the task within a single schedule. More...
 
Schedule Schedule [get]
 Returns the schedule to which the task belongs. More...
 
Task Parent [get]
 Returns the parent task to which the task belongs to. More...
 
override bool IsValid [get]
 
bool IsLeaf [get]
 Returns a value indicating whether the task is a leaf or has one or more child tasks. More...
 
bool IsMilestone [get]
 Returns a value indicating whether the task is a milestone. More...
 
IReadOnlyDictionary< TaskID, TaskChildren [get]
 Returns a collection of all child tasks that are contained within the task. More...
 
string Name [get]
 Returns the name of the task. More...
 
TaskConstraint Constraint [get]
 Returns the constraint of the task. More...
 
DateTime StartDate [get]
 Returns the start date of the task. More...
 
DateTime FinishDate [get]
 Returns the finish date of the task. More...
 
int Duration [get, set]
 Gets or Sets the duration of the task in working hours. More...
 
int ActualDuration [get]
 Returns the time spent for work already performed on the task in working hours. More...
 
int RemainingDuration [get]
 Returns the time required to complete the remaining work on the task in working hours. More...
 
DateTime EarlyStartDate [get]
 Returns the early start date of the task. More...
 
DateTime EarlyFinishDate [get]
 Returns the early finish date of the task. More...
 
DateTime LateStartDate [get]
 Returns the late start date of the task. More...
 
DateTime LateFinishDate [get]
 Returns the late finish date of the task. More...
 
TaskCost Cost [get]
 Returns the cost of the task. More...
 
IAggregatedElementProgressValueProvider MaterialCost [get]
 Returns the material cost of the task. More...
 
IAggregatedElementProgressValueProvider MaterialSupplementCost [get]
 Returns the material supplement cost of the task. More...
 
IAggregatedElementProgressValueProvider LaborCost [get]
 Returns the labor cost of the task. More...
 
IAggregatedElementProgressValueProvider LaborSupplementCost [get]
 Returns the labor supplement cost of the task. More...
 
IAggregatedElementProgressValueProvider EquipmentCost [get]
 Returns the equipment cost of the task. More...
 
IAggregatedElementProgressValueProvider EquipmentSupplementCost [get]
 Returns the equipment supplement cost of the task. More...
 
IAggregatedElementProgressValueProvider OtherCost [get]
 Returns the other cost of the task. More...
 
IAggregatedElementProgressValueProvider SubcontractorCost [get]
 Returns the subcontractor cost of the task. More...
 
TaskRelations Relations [get]
 Returns a collection of all predecessor and successor task relations that are contained within the task. More...
 
TaskElements Elements [get]
 Returns a collection of all elements that are contained within the task. More...
 
IEnumerable< TaskActivityActivities [get]
 Returns a collection of all task activities that are contained within the task. More...
 
IEnumerable< ScheduleResourceResources [get]
 Returns a collection of all schedule resources that are contained within the task. More...
 
TaskCalendar Calendar [get]
 Returns the calendar of the task. More...
 
TaskProgressStatusType ProgressStatus [get]
 Returns the task progress status type of the task. More...
 
TaskLinkRules LinkRules [get]
 Returns the task link rules. More...
 
TaskProperties Properties [get]
 Returns a collection of all task properties that are contained within the task. More...
 
Color Color [get, set]
 Gets or sets the color of the task. More...
 
- Properties inherited from Bexel.Api.IdentifiableApiObject< TaskID >
abstract TId ID [get]
 

Additional Inherited Members

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

Detailed Description

Represents an identifiable unit of work to be carried out in a construction project.

Member Function Documentation

◆ GetAllChildren()

IEnumerable<Task> Bexel.Api.Scheduling.Task.GetAllChildren ( )

Returns a collection of all child tasks that are contained within the task and it's subtasks.

◆ GetAllChildrenIncludingSelf()

IEnumerable<Task> Bexel.Api.Scheduling.Task.GetAllChildrenIncludingSelf ( )

Returns a collection of all child tasks that are contained within the task and it's subtasks, including itself.

Property Documentation

◆ Activities

IEnumerable<TaskActivity> Bexel.Api.Scheduling.Task.Activities
get

Returns a collection of all task activities that are contained within the task.

◆ ActualDuration

int Bexel.Api.Scheduling.Task.ActualDuration
get

Returns the time spent for work already performed on the task in working hours.

◆ Calendar

TaskCalendar Bexel.Api.Scheduling.Task.Calendar
get

Returns the calendar of the task.

◆ Children

IReadOnlyDictionary<TaskID, Task> Bexel.Api.Scheduling.Task.Children
get

Returns a collection of all child tasks that are contained within the task.

◆ Color

Color Bexel.Api.Scheduling.Task.Color
getset

Gets or sets the color of the task.

◆ Constraint

TaskConstraint Bexel.Api.Scheduling.Task.Constraint
get

Returns the constraint of the task.

◆ Cost

TaskCost Bexel.Api.Scheduling.Task.Cost
get

Returns the cost of the task.

◆ Duration

int Bexel.Api.Scheduling.Task.Duration
getset

Gets or Sets the duration of the task in working hours.

◆ EarlyFinishDate

DateTime Bexel.Api.Scheduling.Task.EarlyFinishDate
get

Returns the early finish date of the task.

◆ EarlyStartDate

DateTime Bexel.Api.Scheduling.Task.EarlyStartDate
get

Returns the early start date of the task.

◆ Elements

TaskElements Bexel.Api.Scheduling.Task.Elements
get

Returns a collection of all elements that are contained within the task.

◆ EquipmentCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.EquipmentCost
get

Returns the equipment cost of the task.

◆ EquipmentSupplementCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.EquipmentSupplementCost
get

Returns the equipment supplement cost of the task.

◆ FinishDate

DateTime Bexel.Api.Scheduling.Task.FinishDate
get

Returns the finish date of the task.

◆ ID

override TaskID Bexel.Api.Scheduling.Task.ID
get

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

◆ IsLeaf

bool Bexel.Api.Scheduling.Task.IsLeaf
get

Returns a value indicating whether the task is a leaf or has one or more child tasks.

◆ IsMilestone

bool Bexel.Api.Scheduling.Task.IsMilestone
get

Returns a value indicating whether the task is a milestone.

◆ LaborCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.LaborCost
get

Returns the labor cost of the task.

◆ LaborSupplementCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.LaborSupplementCost
get

Returns the labor supplement cost of the task.

◆ LateFinishDate

DateTime Bexel.Api.Scheduling.Task.LateFinishDate
get

Returns the late finish date of the task.

◆ LateStartDate

DateTime Bexel.Api.Scheduling.Task.LateStartDate
get

Returns the late start date of the task.

◆ LinkRules

TaskLinkRules Bexel.Api.Scheduling.Task.LinkRules
get

Returns the task link rules.

◆ MaterialCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.MaterialCost
get

Returns the material cost of the task.

◆ MaterialSupplementCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.MaterialSupplementCost
get

Returns the material supplement cost of the task.

◆ Name

string Bexel.Api.Scheduling.Task.Name
get

Returns the name of the task.

◆ OtherCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.OtherCost
get

Returns the other cost of the task.

◆ Parent

Task Bexel.Api.Scheduling.Task.Parent
get

Returns the parent task to which the task belongs to.

◆ ProgressStatus

TaskProgressStatusType Bexel.Api.Scheduling.Task.ProgressStatus
get

Returns the task progress status type of the task.

◆ Properties

TaskProperties Bexel.Api.Scheduling.Task.Properties
get

Returns a collection of all task properties that are contained within the task.

◆ Relations

TaskRelations Bexel.Api.Scheduling.Task.Relations
get

Returns a collection of all predecessor and successor task relations that are contained within the task.

◆ RemainingDuration

int Bexel.Api.Scheduling.Task.RemainingDuration
get

Returns the time required to complete the remaining work on the task in working hours.

◆ Resources

IEnumerable<ScheduleResource> Bexel.Api.Scheduling.Task.Resources
get

Returns a collection of all schedule resources that are contained within the task.

◆ Schedule

Schedule Bexel.Api.Scheduling.Task.Schedule
get

Returns the schedule to which the task belongs.

◆ StartDate

DateTime Bexel.Api.Scheduling.Task.StartDate
get

Returns the start date of the task.

◆ SubcontractorCost

IAggregatedElementProgressValueProvider Bexel.Api.Scheduling.Task.SubcontractorCost
get

Returns the subcontractor cost of the task.