Package de.aeb.xnsg.simplerouting.bf

Interface IRoutingBF

@BusinessFacade
public interface IRoutingBF

Routing related business facade methods. Supports direct routing and in later version path routing will be supported.

Method Summary

Modifier and Type	Method	Description
CreateRoutingTaskResponseDTO	createRoutingTask(CreateRoutingTaskRequestDTO request)	Creates a new routing task and returns a unique task id. In case of successful creation, the response will contain the unique taskId of the created routing task.
CreateSupplementTaskResponseDTO	createSupplementTask(CreateSupplementTaskRequestDTO request)	Creates a new supplement task and returns a unique task id. In case of successful creation, the response will contain the unique taskId of the created supplement task.
GetAllCarriersResponseDTO	getAllCarriers(GetAllCarriersRequestDTO request)	Returns all carriers available for the target client. This call might help to find the correct identCode of a carrier and service as well as the value-added services belonging to that carrier, which shall be added to the supplement task by using createSupplementTask(CreateSupplementTaskRequestDTO).
GetHandoverPointsResponseDTO	getHandoverPoints(GetHandoverPointsRequestDTO request)	Returns all handover points available for the target client. Handover points are master file data.
GetRatingProfilesResponseDTO	getRatingProfiles(GetRatingProfilesRequestDTO request)	Returns all rating profiles available for the target client. This call might help to find the correct identCode of a rating profile, which shall be added to the routing task by using createRoutingTask(CreateRoutingTaskRequestDTO).
GetRoutingTaskResultResponseDTO	getRejectedRoutingTaskResult(GetRoutingTaskResultRequestDTO request)	Returns a sorted list of the rejected proposals for the provided task id and its current calculation state. The rejected proposals are those proposals which were filtered out according to the settings in the rating profile. Possible states of calculation are: - INPROGRESS: entries (and ordering) might change in future calls.
GetRoutingRequirementTypesResponseDTO	getRoutingRequirementTypes(GetRoutingRequirementTypesRequestDTO request)	Returns all requirements and requirement types available for the target client. This call might help to find the correct identCode of a requirement, which shall be added to the routing task by using createRoutingTask(CreateRoutingTaskRequestDTO).
GetRoutingTaskResultResponseDTO	getRoutingTaskResult(GetRoutingTaskResultRequestDTO request)	Returns a sorted list of proposals for the provided task id and its current calculation state. The final list of proposals is ranked according to a rating profile.
GetSupplementTaskResultResponseDTO	getSupplementTaskResult(GetSupplementTaskResultRequestDTO request)	Returns an intermediate result of calculated supplements for the provided task id and its current calculation state. Possible states of calculation are: - INPROGRESS: entries (and ordering) might change in future calls.
WaitForRoutingTaskResultResponseDTO	waitForRoutingTaskResult(WaitForRoutingTaskResultRequestDTO request)	Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state. If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached. The final list of proposals is ranked according to a rating profile.

Method Details

waitForRoutingTaskResult

WaitForRoutingTaskResultResponseDTO waitForRoutingTaskResult(WaitForRoutingTaskResultRequestDTO request)

Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state.

If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached.

The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).

Parameters:

request - WaitForRoutingTaskResultRequestDTO

Returns:

WaitForRoutingTaskResultResponseDTO

createRoutingTask

CreateRoutingTaskResponseDTO createRoutingTask(CreateRoutingTaskRequestDTO request)

Creates a new routing task and returns a unique task id.

In case of successful creation, the response will contain the unique taskId of the created routing task. The respective routing task can be found by this task id. Proposal calculation starts in an asynchronous process. The current state of calculation can be requested by handing over the provided task id via the call of getRoutingTaskResult(GetRoutingTaskResultRequestDTO) or waitForRoutingTaskResult(WaitForRoutingTaskResultRequestDTO).

Parameters:

request - CreateRoutingTaskRequestDTO

Returns:

CreateRoutingTaskResponseDTO

getRoutingTaskResult

GetRoutingTaskResultResponseDTO getRoutingTaskResult(GetRoutingTaskResultRequestDTO request)

Returns a sorted list of proposals for the provided task id and its current calculation state.

The final list of proposals is ranked according to a rating profile. A rating profile uses supplements for score calculation and ranking.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).

Parameters:

request - GetRoutingTaskResultRequestDTO

Returns:

GetRoutingTaskResultResponseDTO

getRejectedRoutingTaskResult

GetRoutingTaskResultResponseDTO getRejectedRoutingTaskResult(GetRoutingTaskResultRequestDTO request)

Returns a sorted list of the rejected proposals for the provided task id and its current calculation state.
The rejected proposals are those proposals which were filtered out according to the settings in the rating profile.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- RANKED: ordering and entries fixed, at least one supplement missing.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new routing task can be created by using createRoutingTask(CreateRoutingTaskRequestDTO).

Parameters:

request - GetRoutingTaskResultRequestDTO

Returns:

GetRoutingTaskResultResponseDTO

createSupplementTask

CreateSupplementTaskResponseDTO createSupplementTask(CreateSupplementTaskRequestDTO request)

Creates a new supplement task and returns a unique task id.

In case of successful creation, the response will contain the unique taskId of the created supplement task. The respective supplement task can be found by this task id. Supplement calculation starts in an asynchronous process. The current state of calculation can be request by handing over the provided task id via the call of getSupplementTaskResult(GetSupplementTaskResultRequestDTO).

Parameters:

request - CreateSupplementTaskRequestDTO

Returns:

CreateSupplementTaskResponseDTO

getSupplementTaskResult

GetSupplementTaskResultResponseDTO getSupplementTaskResult(GetSupplementTaskResultRequestDTO request)

Returns an intermediate result of calculated supplements for the provided task id and its current calculation state.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
- COMPLETE: ordering and entries fixed, all supplements are calculated.

A new supplement task can be created by using createSupplementTask(CreateSupplementTaskRequestDTO).

Parameters:

request - GetSupplementTaskResultRequestDTO

Returns:

GetSupplementTaskResultResponseDTO

getRoutingRequirementTypes

GetRoutingRequirementTypesResponseDTO getRoutingRequirementTypes(GetRoutingRequirementTypesRequestDTO request)

Returns all requirements and requirement types available for the target client.

This call might help to find the correct identCode of a requirement, which shall be added to the routing task by using createRoutingTask(CreateRoutingTaskRequestDTO).

Parameters:

request - GetRoutingRequirementTypesRequestDTO

Returns:

GetRoutingRequirementTypesResponseDTO

getRatingProfiles

GetRatingProfilesResponseDTO getRatingProfiles(GetRatingProfilesRequestDTO request)

Returns all rating profiles available for the target client.

This call might help to find the correct identCode of a rating profile, which shall be added to the routing task by using createRoutingTask(CreateRoutingTaskRequestDTO). This becomes more important, if a rating profile other than the default profile shall be used for proposal calculation.

Parameters:

request - GetRatingProfilesRequestDTO

Returns:

GetRatingProfilesResponseDTO

getHandoverPoints

GetHandoverPointsResponseDTO getHandoverPoints(GetHandoverPointsRequestDTO request)

Returns all handover points available for the target client.

Handover points are master file data. This call can be used to choose a handover point from a drop down application. It is not intended that this call is used for master data maintenance or master data synchronization.

The address is not included in the response.

Parameters:

request - GetHandoverPointsRequestDTO

Returns:

GetHandoverPointsResponseDTO

getAllCarriers

GetAllCarriersResponseDTO getAllCarriers(GetAllCarriersRequestDTO request)

Returns all carriers available for the target client.

This call might help to find the correct identCode of a carrier and service as well as the value-added services belonging to that carrier, which shall be added to the supplement task by using createSupplementTask(CreateSupplementTaskRequestDTO).

Parameters:

request - GetAllCarriersRequestDTO

Returns:

GetAllCarriersResponseDTO