TruckFlowDeviceController

Main N4 Entity

N/A

Functionality

Road Module

Interfaces to external devices. Allows overriding of the default N4 messaging to interface with external devices.

Description

As of 2.2 only the open-gate-arm message is supported. This is an outbound call made from N4 to the GOS that passes <open-gate-arm>.

Interface Method(s) and Injected Data

String response =  openBarrier(Gate inGate, CachedGateStage inStage, GateLane inLane, String inTvStatus, Long inGosTvKey)

Parameters

inGateThe current gate of the truck

inStageThe current stage of the truck

inLaneThe current lane of the truck

inTvStatusThe status of the truck visit - OK, TROUBLE, COMPLETE

inGosTvKeyThe GOS's uid for the truck visit

Expected responses:

1.A string OK or ERROR

2.A string starting <?xml indicating that the response is xml. If xml the status can be indicated by an attribute status = "3" or status-id="SEVERE" in the root element.

Exception/Transaction Handling

Call will be assumed to have failed if an exception is thrown. ie equivalent to the ERROR response.

Availability

2.2+