Interface java.telephony.callcenter.CallCenterCall
All Packages Class Hierarchy This Package Previous Next Index
Interface java.telephony.callcenter.CallCenterCall
- public interface CallCenterCall
- extends Object
- extends CallControlCall
-
ANSWERING_TREATMENT_CONNECT
- This answering endpoint treatment indicates that call should be
connected if answering endpoint is detected.
-
ANSWERING_TREATMENT_DROP
- This answering endpoint treatment indicates that call should be
dropped if answering endpoint is detected.
-
ANSWERING_TREATMENT_NONE
- This answering endpoint treatment indicates that no treatment is
specified.
-
ANSWERING_TREATMENT_PROVIDER_DEFAULT
- This answering endpoint treatment indicates that treatment should
follow the provider's default treatment administration.
-
ENDPOINT_ANSWERING_MACHINE
- This indicates that the endpoint answering the call may be an
answering machine.
-
ENDPOINT_ANY
- This indicates that the endpoint answering the call may be
any thing.
-
ENDPOINT_FAX_MACHINE
- This indicates that the endpoint answering the call may be a
fax machine.
-
ENDPOINT_HUMAN_INTERVENTION
- This indicates that the endpoint answering the call may be a
human.
-
MAX_RINGS
- Maximum number of rings allowed before classifying the call as no
answer.
-
MIN_RINGS
- Minimum number of rings allowed before classifying the call as no
answer.
-
connectPredictive(Terminal, Address, String, int, int, int, int)
- This method connects a pair of connections to a call, attempting
to connect the destination first.
-
getApplicationData()
- Returns the application specific data associated with the call.
-
getTrunks()
- Returns an array of all Trunks currently being used for this Call.
-
setApplicationData(Object)
- This method associates application specific data with a call.
MIN_RINGS
public final static int MIN_RINGS
- Minimum number of rings allowed before classifying the call as no
answer.
MAX_RINGS
public final static int MAX_RINGS
- Maximum number of rings allowed before classifying the call as no
answer.
ANSWERING_TREATMENT_PROVIDER_DEFAULT
public final static int ANSWERING_TREATMENT_PROVIDER_DEFAULT
- This answering endpoint treatment indicates that treatment should
follow the provider's default treatment administration.
ANSWERING_TREATMENT_DROP
public final static int ANSWERING_TREATMENT_DROP
- This answering endpoint treatment indicates that call should be
dropped if answering endpoint is detected.
ANSWERING_TREATMENT_CONNECT
public final static int ANSWERING_TREATMENT_CONNECT
- This answering endpoint treatment indicates that call should be
connected if answering endpoint is detected.
ANSWERING_TREATMENT_NONE
public final static int ANSWERING_TREATMENT_NONE
- This answering endpoint treatment indicates that no treatment is
specified.
ENDPOINT_ANSWERING_MACHINE
public final static int ENDPOINT_ANSWERING_MACHINE
- This indicates that the endpoint answering the call may be an
answering machine.
ENDPOINT_FAX_MACHINE
public final static int ENDPOINT_FAX_MACHINE
- This indicates that the endpoint answering the call may be a
fax machine.
ENDPOINT_HUMAN_INTERVENTION
public final static int ENDPOINT_HUMAN_INTERVENTION
- This indicates that the endpoint answering the call may be a
human.
ENDPOINT_ANY
public final static int ENDPOINT_ANY
- This indicates that the endpoint answering the call may be
any thing.
connectPredictive
public abstract Connection[] connectPredictive(Terminal originatorTerminal,
Address originatorAddress,
String destination,
int connectionState,
int maxRings,
int answeringTreatment,
int answeringEndpointType) throws PlatformException
- This method connects a pair of connections to a call, attempting
to connect the destination first. After the destination connection
is CONNECTED, ALERTING, NETWORK_REACHED or NETWORK_ALERTING as
specified by the connectionState, an attempt is made to connect the
originator.
The method returns when the Connection objects are created.
The connection objects go through one or more state transitions to
go from an intial IDLE state to a final CONNECTED state.
The pre-condition predicates for the CallCenterCall.connectPredictive()
method indicate the statements that must be true in order for the method
to succeed. However, these predicates do not guarantee success.
The variable "call" represents the instance of the CallCenterCall object.
1. (call.getProvider()).getState() == IN_SERVICE
2. call.getState() == IDLE
The post-condition predicates for the CallCenterCall.connectPredictive()
method are as follows. connectionState is provided by the application.
1. (call.getProvider()).getState() == IN_SERVCE
2. call.getState() == ACTIVE
3. c = call.getConnections() && sizeof(c) == 2
4. c = call.getConnections() && c[0].getState() == connectionState
5. c = call.getConnections() && c[1].getState() == IDLE
- Parameters:
- originatorTerminal - The originating Terminal of the telephone call.
This is optional when the originator is for example an ACDAddress.
- originatorAddress - The originating Address of the telephone call.
- destination - This must be a complete and valid telephone number.
- connectionState - The application may set this to CONNECTED
ALERTING, NETWORK_REACHED or NETWORK_ALERTING.
- maxRings - This specifies the the number of rings that are allowed
before classifying the call as no answer. The allowed range is from
MIN_RINGS of 2 to MAX_RINGS of 15.
- answeringTreatment - This specifies the call treatment when an
answering endpoint is detected. The set includes
ANSWERING_TREATMENT_PROVIDER_DEFAULT, ANSWERING_TREATMENT_DROP,
ANSWERING_TREATMENT_CONNECT and ANSWERING_TREATMENT_NONE.
- answeringEndPointType - This specifies the type of answering
endpoint. The set includes ENDPOINT_ANSWERING_MACHINE,
ENDPOINT_FAX_MACHINE, ENDPOINT_HUMAN_INTERVENTION, ENDPOINT_ANY.
- Returns:
- A pair of Connections.
- Throws: PlatformException
- A platform-specific exception occurred.
setApplicationData
public abstract void setApplicationData(Object data) throws PlatformException
- This method associates application specific data with a call. The
format of the data is application specific. If application specific
data exists for the call an application can clear it from the call
by passing a NULL object.
The Call must be either IDLE or ACTIVE before this method is valid.
The Provider must also be IN_SERVICE.
The pre-conditions for this method are given by the following:
1. (call.getProvider()).getState() == IN_SERVICE
2. call.getState() == ACTIVE or IDLE
Notes: The application specific data associated with the Call object
from which the conference or transfer method is invoked will be
retained with the call.
An ApplicationDataEvent will be sent when this method is
used or the provider associates data with the call from another
source.
- Parameters:
- data - The data to be associated with the call.
- Throws: PlatformException
- A platform-specific exception occurred.
getApplicationData
public abstract Object getApplicationData() throws PlatformException
- Returns the application specific data associated with the call.
The Call must be either IDLE or ACTIVE before this method is valid.
The Provider must also be IN_SERVICE.
The pre-conditions for this method are given by the following:
1. (call.getProvider()).getState() == IN_SERVICE
2. call.getState() == ACTIVE or IDLE
- Returns:
- s String The data to be associated with the call.
- Throws: PlatformException
- A platform-specific exception occurred.
getTrunks
public abstract CallCenterTrunk[] getTrunks() throws PlatformException
- Returns an array of all Trunks currently being used for this Call.
If there are no Trunks being used, this method returns null.
- Returns:
- An array of Trunks, null if there are
none.
- Throws: PlatformException
- A platform-specific exception occurred.
All Packages Class Hierarchy This Package Previous Next Index