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.
-
CAUSE_INVALID_DESTINATION
- Cause code indicating that the provider is ending the route
session because the application included an invalid destination
in the routeSelect().
-
CAUSE_NO_ERROR
- Cause code indicating no error.
-
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.
-
CAUSE_ROUTING_TIMER_EXPIRED
- Cause code indicating a routing timer has expired.
-
CAUSE_STATE_INCOMPATIBLE
- Cause code indicating that the provider is ending the route
session because the Connection state is incompatible with the
RouteSession.
-
CAUSE_UNSPECIFIED_ERROR
- Cause code indicating that the provider is ending the route
session because some unspecified erroroccurred.
-
RE_ROUTE
- The RouteSession object transitions to the RE_ROUTE state when
the provider requests the application to select another route
for a call.
-
ROUTE
- The RouteSession object transitions to the ROUTE state when
the provider requests the application to route a call.
-
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.
-
ROUTE_END
- The RouteSession object transitions to the ROUTE_END state
when the provider informs the application of termination
of a RouteSession.
-
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.
-
endRoute(int)
- An application uses this method to end a route session.
-
getCause()
- An application uses this method to get the cause associated
with the state of the route session.
-
getRouteAddress()
- This returns the RouteAddress that the application has
registered to route calls for.
-
getState()
- An application uses this method to get the state of a route
session.
-
selectRoute(String[])
- An application uses this method to send back a selected route.
ROUTE
public final static int ROUTE
- The RouteSession object transitions to the ROUTE state when
the provider requests the application to route a call.
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.
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.
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.
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.
CAUSE_NO_ERROR
public final static int CAUSE_NO_ERROR
- Cause code indicating no error.
CAUSE_ROUTING_TIMER_EXPIRED
public final static int CAUSE_ROUTING_TIMER_EXPIRED
- Cause code indicating a routing timer has expired.
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.
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().
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.
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.
getRouteAddress
public abstract RouteAddress getRouteAddress()
- This returns the RouteAddress that the application has
registered to route calls for.
selectRoute
public abstract void selectRoute(String routeSelected[]) throws PlatformException
- An application uses this method to send back a selected route.
endRoute
public abstract void endRoute(int errorValue) throws PlatformException
- An application uses this method to end a route session.
getState
public abstract int getState() throws PlatformException
- An application uses this method to get the state of a route
session.
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