Skip to content

Latest commit

 

History

History
268 lines (191 loc) · 10.1 KB

Logistics.Shipment.TransportationVehicles.md

File metadata and controls

268 lines (191 loc) · 10.1 KB
Raw
uid
Logistics.Shipment.TransportationVehicles

Logistics.Shipment.TransportationVehicles Entity

Namespace: Logistics.Shipment

A vehicle, which is used for transportation. One actual vehicle might be defined multiple times as transportation vehicle - for different modes of transportation or cargo types. Entity: Log_Transportation_Vehicles

Default Visualization

Default Display Text Format:
{Code}: {Vehicle.VehicleType:T}, {Vehicle.VehicleRegistrationNumber:T}
Default Search Members:
Code; Vehicle.EngineIdentificationNumber
Code Data Member:
Code
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
Code string (16) The unique code (or call sign) of this transportation vehicle. Required Filter(eq;like) ORD
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
MaxCargoWeightKg int32 nullable The maximum weight of the cargo (in kg), which can be transported. null when this is unknown and no limit should be enforced.
MaxPalletsCount int32 nullable The maximum number of pallets, which can be transported by the vehicle. null when this is unknown and no limit should be enforced.
Notes string (max) nullable Notes for this TransportationVehicle.
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.

References

Name Type Description
CargoType CargoTypes The cargo type supported by this transportation vehicle. Required Filter(multi eq)
Carrier Carriers (nullable) The carrier, operating the vehicle. null for our own vehicles. Filter(multi eq) Introduced in version 23.1.2.9
EnterpriseCompany EnterpriseCompanies The enterprise company to which the transportation vehicle will be bound. Required Filter(multi eq)
TransportationMode TransportationModes The mode of transportation provided by this transportation vehicle. The same base vehicle might be used for more than one mode. Required Filter(multi eq)
Vehicle Vehicles The definition of the base vehicle. Required Filter(multi eq) Owner

Attribute Details

Code

The unique code (or call sign) of this transportation vehicle. Required Filter(eq;like) ORD

Type: string (16)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault

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

MaxCargoWeightKg

The maximum weight of the cargo (in kg), which can be transported. null when this is unknown and no limit should be enforced.

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

MaxPalletsCount

The maximum number of pallets, which can be transported by the vehicle. null when this is unknown and no limit should be enforced.

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

Notes

Notes for this TransportationVehicle.

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

Reference Details

CargoType

The cargo type supported by this transportation vehicle. Required Filter(multi eq)

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

Carrier

The carrier, operating the vehicle. null for our own vehicles. Filter(multi eq) Introduced in version 23.1.2.9

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

EnterpriseCompany

The enterprise company to which the transportation vehicle will be bound. Required Filter(multi eq)

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

TransportationMode

The mode of transportation provided by this transportation vehicle. The same base vehicle might be used for more than one mode. Required Filter(multi eq)

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

Vehicle

The definition of the base vehicle. 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=Logistics.Shipment.TransportationVehicles erp.type=business-rule default-text="None"]

Front-End Business Rules

[!list limit=1000 erp.entity=Logistics.Shipment.TransportationVehicles erp.type=front-end-business-rule default-text="None"]

API

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

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