javax.telephony.callcenter
Interface RouteCallback

public interface RouteCallback

The RouteCallback interface is used by applications to receive routing requests for a particular RouteSession. Applications instantiates an object which implements this interface and registers the callback for a particular routeable address via the RouteAddress.registerRouteCallback() method.

Applications override the individual methods defined by this interface, each of which corresponds to a different kind of routing request.

See Also:

RouteAddress, RouteSession

Method Summary

void	reRouteEvent(ReRouteEvent event) This method indicates the application is being asked to select another route for a Call.
void	routeCallbackEndedEvent(RouteCallbackEndedEvent event) This method indicates that this callback will no longer receive routing requests or routing information and the callback has been terminated.
void	routeEndEvent(RouteEndEvent event) This method indicates that a routing session has ended.
void	routeEvent(RouteEvent event) This method indicates the application is being asked to route a Call.
void	routeUsedEvent(RouteUsedEvent event) This method indicates that a Call has successfully reached a final destination which the application has selected.

Method Detail

routeEvent

public void routeEvent(RouteEvent event)

This method indicates the application is being asked to route a Call. The RouteSession associated with this RouteCallback has transitioned into the RouteSession.ROUTE state.

Parameters:

event - The RouteEvent object describing the routing request.

reRouteEvent

public void reRouteEvent(ReRouteEvent event)

This method indicates the application is being asked to select another route for a Call. The RouteSession associated with this RouteCallback has transitioned into the RouteSession.RE_ROUTE state.

Parameters:

event - The ReRouteEvent object describing the routing request.

routeUsedEvent

public void routeUsedEvent(RouteUsedEvent event)

This method indicates that a Call has successfully reached a final destination which the application has selected. The RouteSession associated with this RouteCallback has transitioned into the RouteSession.ROUTE_USED state.

Parameters:

event - The RouteUsedEvent object describing the route used.

routeEndEvent

public void routeEndEvent(RouteEndEvent event)

This method indicates that a routing session has ended. The RouteSession associated with this RouteCallback has transitioned into the RouteSession.ROUTE_END state.

Parameters:

event - The RouteEndEvent object describing the ending of the routing session.

routeCallbackEndedEvent

public void routeCallbackEndedEvent(RouteCallbackEndedEvent event)

This method indicates that this callback will no longer receive routing requests or routing information and the callback has been terminated. The RouteSession associated with this RouteCallback has transitioned into the RouteSession.ROUTE_CALLBACK_ENDED state.

Parameters:

event - The RouteCallbackEndedEvent object describing the ending of the routing callback.