Applications.Service.ServiceAgreementLines Entity

Namespace: Applications.Service

Service agreement lines represent the individual serviced objects that are covered by the service agreement. Entity: Srv_Service_Agreement_Lines

Default Visualization

Default Display Text Format:
{Id}. {ServiceAgreement.DocumentNo} {ServiceAgreement.DocumentType.TypeName:T}
Default Search Members:
ServiceAgreement.DocumentNo
Name Data Member:
ServiceAgreement.EntityName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

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

Aggregate Parent:
Applications.Service.ServiceAgreements
Aggregate Root:
Applications.Service.ServiceAgreements

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
LineEndDateTime	datetime	The ending date and time of the agreement coverage for the current line. `Required` `Filter(ge;le)`
LineNo	int32	Consecutive line number, unique within the document. Usually is increasing in steps of 10, like in 10, 20, 30, etc. `Required` `Filter(eq)`
LineStartDateTime	datetime	The starting date and time of the agreement coverage for the current line. `Required` `Filter(ge;le)`
Notes	string (254) nullable	Notes for this ServiceAgreementLine.
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.
ParentLineNo	int32 nullable	The number of the line within the parent document, which the current line executes. null when the current line does not execute another line. `Introduced in version 22.1.5.18`
Quantity	decimal (14, 3)	The quantity of the service object that is included in the agreement. `Required` `Default(1)` `Filter(ge;le)`

References

Name	Type	Description
Document	ServiceAgreements	The to which this ServiceAgreementLine belongs. `Required` `Filter(multi eq)`
ParentDocument	Documents (nullable)	The document, which the current line executes. null when the current line does not execute another line. `Filter(multi eq)`
ServiceAgreement	ServiceAgreements	The to which this ServiceAgreementLine belongs. `Required` `Filter(multi eq)` `Owner`
ServiceObject	ServiceObjects	The service object, which is covered by the current agreement. `Required` `Filter(multi eq)`
ServiceType	ServiceTypes	The type (level) of service that is agreed. `Required` `Filter(multi eq)`

Attribute Details

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

LineEndDateTime

The ending date and time of the agreement coverage for the current line. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
obj.ServiceAgreement.EndDateTime

Front-End Recalc Expressions:
obj.ServiceAgreement.EndDateTime

LineNo

Consecutive line number, unique within the document. Usually is increasing in steps of 10, like in 10, 20, 30, etc. Required Filter(eq)

Type: int32
Category: System
Supported Filters: Equals
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.ServiceAgreement.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

Front-End Recalc Expressions:
( obj.ServiceAgreement.Lines.Select( c => c.LineNo).DefaultIfEmpty( 0).Max( ) + 10)

LineStartDateTime

The starting date and time of the agreement coverage for the current line. Required Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
obj.ServiceAgreement.StartDateTime

Front-End Recalc Expressions:
obj.ServiceAgreement.StartDateTime

Notes

Notes for this ServiceAgreementLine.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

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

ParentLineNo

The number of the line within the parent document, which the current line executes. null when the current line does not execute another line. Introduced in version 22.1.5.18

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

Quantity

The quantity of the service object that is included in the agreement. Required Default(1) Filter(ge;le)

Type: decimal (14, 3)
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

Reference Details

Document

The to which this ServiceAgreementLine belongs. Required Filter(multi eq)

Type: ServiceAgreements
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ParentDocument

The document, which the current line executes. null when the current line does not execute another line. Filter(multi eq)

Type: Documents (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ServiceAgreement

The to which this ServiceAgreementLine belongs. Required Filter(multi eq) Owner

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

ServiceObject

The service object, which is covered by the current agreement. Required Filter(multi eq)

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

ServiceType

The type (level) of service that is agreed. Required Filter(multi eq)

Type: ServiceTypes
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

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST