Interface ITelematicService

Namespace: Simplic.Telematic.Core

Assembly: Simplic.Telematic.Core.dll

Syntax

public interface ITelematicService

Methods

Execute(TelematicQueueItem)

Resolves what context to use, what telematic system to use, executes the python script and changes the status of the queue item accordingly.

Declaration

bool Execute(TelematicQueueItem telematicQueueItem)

Parameters

Type	Name	Description
TelematicQueueItem	telematicQueueItem

Returns

Type	Description
System.Boolean	True if successfull

ExecuteAll()

Gets a list of queue items and executes them

Declaration

bool ExecuteAll()

Returns

Type	Description
System.Boolean	True if successfull

GetAllAvailableSystems()

Gets a list of all used telematic systems

Declaration

IEnumerable<Guid> GetAllAvailableSystems()

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.Guid>	Returns a list of GUIDs of telematic systems

GetAllFunctions()

Gets all functions

Declaration

IEnumerable<TelematicFunction> GetAllFunctions()

Returns

Type	Description
System.Collections.Generic.IEnumerable<TelematicFunction>	A list of TelematicFunction

GetAllFunctionsByContextId(Guid)

Gets all functions by context Id

Declaration

IEnumerable<TelematicFunction> GetAllFunctionsByContextId(Guid contextId)

Parameters

Type	Name	Description
System.Guid	contextId

Returns

Type	Description
System.Collections.Generic.IEnumerable<TelematicFunction>	A list of TelematicFunction

GetAllInQueue()

Returns a list of telematic queue items filtered by their status

Declaration

IEnumerable<TelematicQueueItem> GetAllInQueue()

Returns

Type	Description
System.Collections.Generic.IEnumerable<TelematicQueueItem>	A list of TelematicQueueItem

GetAllQueue()

Returns a list of telematic queue items

Declaration

IEnumerable<TelematicQueueItem> GetAllQueue()

Returns

Type	Description
System.Collections.Generic.IEnumerable<TelematicQueueItem>	A list of TelematicQueueItem

GetAllSystems()

Gets all systems

Declaration

IEnumerable<TelematicSystem> GetAllSystems()

Returns

Type	Description
System.Collections.Generic.IEnumerable<TelematicSystem>

GetContext(Guid)

Gets a context

Declaration

TelematicContext GetContext(Guid contextId)

Parameters

Type	Name	Description
System.Guid	contextId	Context Id to look for

Returns

Type	Description
TelematicContext	TelematicContext

GetFunction(Guid)

Gets a function

Declaration

TelematicFunction GetFunction(Guid functionId)

Parameters

Type	Name	Description
System.Guid	functionId	Function Id to look for

Returns

Type	Description
TelematicFunction	TelematicFunction

GetFunctionSystem(Guid)

Gets a TelematicFunctionSystem

Declaration

TelematicFunctionSystem GetFunctionSystem(Guid functionSystemId)

Parameters

Type	Name	Description
System.Guid	functionSystemId	A telematic function system id

Returns

Type	Description
TelematicFunctionSystem	Returns an Instance of a TelematicFunctionSystem

GetFunctionSystem(Guid, Guid)

Gets a function by the funktionSystem and the vehicle

Declaration

TelematicFunctionSystem GetFunctionSystem(Guid functionId, Guid VehicleId)

Parameters

Type	Name	Description
System.Guid	functionId
System.Guid	VehicleId	A vehicle Id

Returns

Type	Description
TelematicFunctionSystem	Returns a TelematicFunctionSystem

GetInQueueScript(Guid)

Gets the processing script for in queue items

Declaration

TelematicInQueueScript GetInQueueScript(Guid systemId)

Parameters

Type	Name	Description
System.Guid	systemId

Returns

Type	Description
TelematicInQueueScript	Returns a telematic in queue script for the telematicSystem

GetSystem(Guid)

Gets a telematic system (e.g. FleetBoard)

Declaration

TelematicSystem GetSystem(Guid systemId)

Parameters

Type	Name	Description
System.Guid	systemId	System Id to look for

Returns

Type	Description
TelematicSystem	TelematicSystem

ProcessAllInQueueItems()

Read all unread Messegas from a telematic system

Declaration

void ProcessAllInQueueItems()

ProcessQueueInItem(TelematicInQueueItem, TelematicInQueueScript)

Processes a queue entry item

Declaration

bool ProcessQueueInItem(TelematicInQueueItem item, TelematicInQueueScript script)

Parameters

Type	Name	Description
TelematicInQueueItem	item
TelematicInQueueScript	script

Returns

Type	Description
System.Boolean	Return whether the item is processed

Queue(TelematicQueueItem)

Adds to the queue of items to be processed later by application server services

Declaration

bool Queue(TelematicQueueItem telematicQueueItem)

Parameters

Type	Name	Description
TelematicQueueItem	telematicQueueItem	Item to queue

Returns

Type	Description
System.Boolean	True if successfull

ReadAllInQueueItems()

Reads all items

Declaration

void ReadAllInQueueItems()

ReprocessInQueueItems(Guid, DateTime, DateTime)

Resets the status of all InQueueItems for all of the telematic systems of the given vehicle in the given time range

Declaration

void ReprocessInQueueItems(Guid vehicleId, DateTime from, DateTime to)

Parameters

Type	Name	Description
System.Guid	vehicleId
System.DateTime	from
System.DateTime	to

ResendTelematicsQueueItem(Guid)

Resends a telematics queue item if its not already send

Declaration

void ResendTelematicsQueueItem(Guid queueItemId)

Parameters

Type	Name	Description
System.Guid	queueItemId	the id of telematicQueueItem that have to be resend

Save(TelematicQueueItem)

Inserts or updates a queue item

Declaration

bool Save(TelematicQueueItem telematicQueueItem)

Parameters

Type	Name	Description
TelematicQueueItem	telematicQueueItem	Item to insert / update

Returns

Type	Description
System.Boolean	True if successfull

SaveInQueueItem(TelematicInQueueItem)

Saves a telematics in queue item to the DB

Declaration

void SaveInQueueItem(TelematicInQueueItem item)

Parameters

Type	Name	Description
TelematicInQueueItem	item	Te telematics in queue item taht is supposed to be saved