Interface java.telephony.callcenter.RouteSession
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface java.telephony.callcenter.RouteSession

public interface RouteSession
extends Object
The RouteSession interface represents an outstanding route request.

Variable Index

 o CAUSE_INVALID_DESTINATION
Cause code indicating that the provider is ending the route session because the application included an invalid destination in the routeSelect().
 o CAUSE_NO_ERROR
Cause code indicating no error.
 o CAUSE_PARAMETER_NOT_SUPPORTED
Cause code indicating that the provider is ending the route session because the application included a parameter in the routeSelect() that the provider does not support.
 o CAUSE_ROUTING_TIMER_EXPIRED
Cause code indicating a routing timer has expired.
 o CAUSE_STATE_INCOMPATIBLE
Cause code indicating that the provider is ending the route session because the Connection state is incompatible with the RouteSession.
 o CAUSE_UNSPECIFIED_ERROR
Cause code indicating that the provider is ending the route session because some unspecified erroroccurred.
 o RE_ROUTE
The RouteSession object transitions to the RE_ROUTE state when the provider requests the application to select another route for a call.
 o ROUTE
The RouteSession object transitions to the ROUTE state when the provider requests the application to route a call.
 o ROUTE_CALLBACK_ENDED
The RouteSession object transitions to the ROUTE_CALLBACK_ENDED state when the provider informs the application of the termination of a previous registration of a route callback.
 o ROUTE_END
The RouteSession object transitions to the ROUTE_END state when the provider informs the application of termination of a RouteSession.
 o ROUTE_USED
The RouteSession object transitions to the ROUTE_USED state when the provider informs the application of the destination of a call the application helped to route.

Method Index

 o endRoute(int)
An application uses this method to end a route session.
 o getCause()
An application uses this method to get the cause associated with the state of the route session.
 o getRouteAddress()
This returns the RouteAddress that the application has registered to route calls for.
 o getState()
An application uses this method to get the state of a route session.
 o selectRoute(String[])
An application uses this method to send back a selected route.

Variables

 o ROUTE
  public final static int ROUTE
The RouteSession object transitions to the ROUTE state when the provider requests the application to route a call.
 o ROUTE_USED
  public final static int ROUTE_USED
The RouteSession object transitions to the ROUTE_USED state when the provider informs the application of the destination of a call the application helped to route.
 o ROUTE_END
  public final static int ROUTE_END
The RouteSession object transitions to the ROUTE_END state when the provider informs the application of termination of a RouteSession.
 o RE_ROUTE
  public final static int RE_ROUTE
The RouteSession object transitions to the RE_ROUTE state when the provider requests the application to select another route for a call.
 o ROUTE_CALLBACK_ENDED
  public final static int ROUTE_CALLBACK_ENDED
The RouteSession object transitions to the ROUTE_CALLBACK_ENDED state when the provider informs the application of the termination of a previous registration of a route callback.
 o CAUSE_NO_ERROR
  public final static int CAUSE_NO_ERROR
Cause code indicating no error.
 o CAUSE_ROUTING_TIMER_EXPIRED
  public final static int CAUSE_ROUTING_TIMER_EXPIRED
Cause code indicating a routing timer has expired.
 o CAUSE_PARAMETER_NOT_SUPPORTED
  public final static int CAUSE_PARAMETER_NOT_SUPPORTED
Cause code indicating that the provider is ending the route session because the application included a parameter in the routeSelect() that the provider does not support.
 o CAUSE_INVALID_DESTINATION
  public final static int CAUSE_INVALID_DESTINATION
Cause code indicating that the provider is ending the route session because the application included an invalid destination in the routeSelect().
 o CAUSE_STATE_INCOMPATIBLE
  public final static int CAUSE_STATE_INCOMPATIBLE
Cause code indicating that the provider is ending the route session because the Connection state is incompatible with the RouteSession.
 o CAUSE_UNSPECIFIED_ERROR
  public final static int CAUSE_UNSPECIFIED_ERROR
Cause code indicating that the provider is ending the route session because some unspecified erroroccurred.

Methods

 o getRouteAddress
  public abstract RouteAddress getRouteAddress()
This returns the RouteAddress that the application has registered to route calls for.
 o selectRoute
  public abstract void selectRoute(String routeSelected[]) throws PlatformException
An application uses this method to send back a selected route.
 o endRoute
  public abstract void endRoute(int errorValue) throws PlatformException
An application uses this method to end a route session.
 o getState
  public abstract int getState() throws PlatformException
An application uses this method to get the state of a route session.
 o getCause
  public abstract int getCause() throws PlatformException
An application uses this method to get the cause associated with the state of the route session.

All Packages  Class Hierarchy  This Package  Previous  Next  Index