org.glassfish.cafe.api
Interface Conference

All Superinterfaces:

Communication

public interface Conference
extends Communication

Represents a Conference. It extends a conversation. More than two parties can be added to the conference.

Author:

binod

Nested Class Summary

Nested classes/interfaces inherited from interface org.glassfish.cafe.api.Communication

Communication.State

Method Summary

<P extends MediaParticipant> Collection<P>	getAllMediaParticipants(Class<P> type) Get a collection of particular type of Participants in the conference.
Collection<UserParticipant>	getAllParticipants() Return all the participants in the conference.
String	getDescription() Return the description of the conference.
void	setDescription(String description) Set the description of the conference.

Methods inherited from interface org.glassfish.cafe.api.Communication

addAgent, addParticipant, addParticipant, addParticipant, addParticipant, end, getAgent, getAgents, getInitiator, getName, getParticipant, getParticipant, getState, removeAgent, removeParticipant, removeParticipant, replaceParticipant

Method Detail

setDescription

void setDescription(String description)

Set the description of the conference.

Parameters:

description - Description about the conference.

getDescription

String getDescription()

Return the description of the conference.

Returns:

Description about the conference.

getAllParticipants

Collection<UserParticipant> getAllParticipants()

Return all the participants in the conference.

Returns:

a Collection of UserParticipant objects.

getAllMediaParticipants

<P extends MediaParticipant> Collection<P> getAllMediaParticipants(Class<P> type)

Get a collection of particular type of Participants in the conference.

Type Parameters:

P - Type of the Participant.

Parameters:

type - Class of the Participant.

Returns:

An instance of Participant