Skip navigation links

com.oracle.sft.api
Interface Communication

All Known Subinterfaces:

Conference, Conversation, IMConference, IMConversation, Interaction, MessageObservation, MSRPConference, MSRPConversation, QueryInteraction, UserActivity

public interface Communication

Represents a communication session. Conversation, MessageObservation, Conference, and the other subinterfaces are each a type of Communication that may occur between Participants. A communication session occurs between Participants of the Communication, thus a Communication consists of different types of Participants.

Note that an object of this type is a server side representation.

See Also:

CommunicationSession, CommunicationService, Participant, CommunicationBean

Nested Class Summary

static class

Communication.State Different Communication States.

Method Summary

<T> void	addAgent(String name, Agent<T> agent) Set an agent instance in the communication.
void	end() End the communication.
<T> Agent<T>	getAgent(String name) Gets the agent from its name.
Collection<Agent>	getAgents() Retrieve the agent instance pertaining to the communication.
Participant	getInitiator() Retrieves the participant initiating the communication.
String	getName() Returns the name of the communication.
Communication.State	getState() Return the current state of communication.
<T> Agent<T>	removeAgent(String name) Method to remove an agent from the communication.

Method Detail

end

void end()

End the communication.

getState

Communication.State getState()

Return the current state of communication.

Returns:

State of the communication.

getName

String getName()

Returns the name of the communication. A name is typically assigned when the SFT application creates the communication session. If the application does not provide a name, SFT automatically assigns a name.

Returns:

Name of the communication.

See Also:

Conversation, Conference

addAgent

<T> void addAgent(String name,
                  Agent<T> agent)

Set an agent instance in the communication.

Type Parameters:

T - Type of Agent.

Parameters:

agent - An instance of Agent.

See Also:

Agent

getAgents

Collection<Agent> getAgents()

Retrieve the agent instance pertaining to the communication. This API returns only agents that are not call back agents.

Returns:

agent instance previously set or null if the agent is not set.

getAgent

<T> Agent<T> getAgent(String name)

Gets the agent from its name.

Parameters:

name - Name of the Agent

Returns:

agent

removeAgent

<T> Agent<T> removeAgent(String name)

Method to remove an agent from the communication.

Type Parameters:

T - type

Parameters:

name - name of the agent.

Returns:

agent if it exists.

getInitiator

Participant getInitiator()

Retrieves the participant initiating the communication.

For example, if a Conference is initiated by a phone, the party executing the createConference() method is identified as the initiator. However, if a Conference is initiated by a web-based application, the com.oracle.sft.api.Focus interface is the initiator.

Similarly, when a Conversation is initiated using a phone, the caller is the initiator. If a Conversation is instead initiated using a web-based application, the initiator is specified by the CommunicationSession.createConversation() method.

Returns:

Participant

Skip navigation links