Projects.ProjectTaskMaterials Entity

Namespace: Projects

Contains the materials, which are required for a project task. Entity: Prj_Project_Task_Materials

Default Visualization

Default Display Text Format:
{ProjectTask.TaskName}
Default Search Members:
ProjectTask.TaskName
Name Data Member:
ProjectTask.TaskName
Category: Definitions
Show in UI: CannotBeShown

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Projects.ProjectTasks
Aggregate Root:
Projects.ProjectTasks

Attributes

Name	Type	Description
BudgetedMaterialAmount	Amount (12, 2) nullable	Budgeted amount for the material in the currency of the project. null means there is still no budgeted amount. `Currency: ProjectTask.Project.BudgetingCurrency`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
LineNumber	int32	Line number within the task, increased in steps of 10. Used for sorting purposes. `Required` `Default(0)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Quantity	Quantity (9, 3)	The required quantity of the material. `Unit: QuantityUnit` `Required` `Default(1)`
QuantityBase	decimal (9, 3)	The equivalence of Quantity in the base measurement unit of the Material. `Required` `Default(0)` `ReadOnly`

References

Name	Type	Description
MaterialProduct	Products	The product Id of the required material. `Required` `Filter(multi eq)`
ProjectTask	ProjectTasks	The task for which is the material requirement. `Required` `Filter(multi eq)` `Owner`
QuantityUnit	MeasurementUnits	The measurement unit of the required quantity. `Required` `Filter(multi eq)`

Attribute Details

BudgetedMaterialAmount

Budgeted amount for the material in the currency of the project. null means there is still no budgeted amount. Currency: ProjectTask.Project.BudgetingCurrency

Type: Amount (12, 2) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( obj.MaterialProduct != null), obj.CalculateBudgetMaterialAmount( obj.Quantity), new Amount( 0, obj.ProjectTask.Project.BudgetingCurrency))

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

LineNumber

Line number within the task, increased in steps of 10. Used for sorting purposes. Required Default(0)

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.ProjectTask.Materials.Select( c => c.LineNumber).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.ProjectTask.Materials.Select( c => c.LineNumber).DefaultIfEmpty( 0).Max( ) + 1)

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Quantity

The required quantity of the material. Unit: QuantityUnit Required Default(1)

Type: Quantity (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

QuantityBase

The equivalence of Quantity in the base measurement unit of the Material. Required Default(0) ReadOnly

Type: decimal (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Front-End Recalc Expressions:
IIF( ( ( obj.QuantityUnit != null) AndAlso ( obj.MaterialProduct != null)), obj.Quantity.ConvertTo( obj.MaterialProduct.BaseUnit, obj.MaterialProduct).Value, obj.QuantityBase)

Reference Details

MaterialProduct

The product Id of the required material. Required Filter(multi eq)

Type: Products
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ProjectTask

The task for which is the material requirement. Required Filter(multi eq) Owner

Type: ProjectTasks
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

QuantityUnit

The measurement unit of the required quantity. Required Filter(multi eq)

Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST