Skip to content

Latest commit

 

History

History
235 lines (167 loc) · 7.85 KB

Applications.Fleet.VehicleEquipment.md

File metadata and controls

235 lines (167 loc) · 7.85 KB
Raw
uid
Applications.Fleet.VehicleEquipment

Applications.Fleet.VehicleEquipment Entity

Namespace: Applications.Fleet

Contains the actual and history of equipment, installed on the vehicles. Entity: Fleet_Vehicle_Equipment

Default Visualization

Default Display Text Format:
{Vehicle.EngineIdentificationNumber}
Default Search Members:
Vehicle.EngineIdentificationNumber
Name Data Member:
Vehicle.EngineIdentificationNumber
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Parent:
Applications.Fleet.Vehicles
Aggregate Root:
Applications.Fleet.Vehicles

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EndDate date nullable The date when the equipment was removed. null when the equipment is still installed on the vehicle. Filter(ge;le)
Id guid
Notes string (max) nullable Notes for the installed equipment.
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 int32 Quantity of the equipment. Required Default(1) Filter(ge;le)
StartDate date The installation date of the equipment. Required Filter(ge;le)

References

Name Type Description
EquipmentType EquipmentTypes The type of equipment installed on the vehicle. Required Filter(multi eq)
Vehicle Vehicles The vehicle that is holding the equipment. Required Filter(multi eq) Owner

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

EndDate

The date when the equipment was removed. null when the equipment is still installed on the vehicle. Filter(ge;le)

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

Id

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

Notes

Notes for the installed equipment.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

Quantity

Quantity of the equipment. Required Default(1) Filter(ge;le)

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

StartDate

The installation date of the equipment. Required Filter(ge;le)

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

Reference Details

EquipmentType

The type of equipment installed on the vehicle. Required Filter(multi eq)

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

Vehicle

The vehicle that is holding the equipment. Required Filter(multi eq) Owner

Type: Vehicles
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

[!list limit=1000 erp.entity=Applications.Fleet.VehicleEquipment erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Applications.Fleet.VehicleEquipment erp.type=front-end-business-rule default-text="None"]

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Applications_Fleet_VehicleEquipment?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Applications_Fleet_VehicleEquipment?$top=10