org.exoplatform.webconferencing

Class CallInfo

java.lang.Object

org.exoplatform.webconferencing.CallInfo

public class CallInfo
extends Object

Created by The eXo Platform SAS.

Version:

$Id: CallInfo.java 00000 Jun 19, 2017 pnedonosko $

Author:

Peter Nedonosko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CallInfo.CallView The Class describing a CallInfo with simplified (POJO) fields for consumption by clients.

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	endDate The end date.
protected String	id The id.
protected String	inviteId The invite id.
protected Date	lastDate The last date.
protected static org.exoplatform.services.log.Log	LOG The Constant LOG.
protected Set<OriginInfo>	origins The origins.
protected IdentityInfo	owner The owner.
protected Set<UserInfo>	participants The participants.
protected String	providerType The provider type.
protected Date	startDate The start date.
protected String	state The state.
protected String	title The title.

Constructor Summary

Constructors

Constructor and Description
CallInfo(String id, String title, IdentityInfo owner, String providerType) Instantiates a new call info.

Method Summary

Modifier and Type	Method and Description
void	addOrigin(OriginInfo origin) Adds the origin.
void	addOrigins(Collection<OriginInfo> origins) Adds the origins.
void	addParticipant(UserInfo part) Adds the participant.
void	addParticipants(Collection<UserInfo> parts) Adds the participants.
Date	getEndDate() Gets the end date.
String	getId() Gets the id.
String	getInviteId() Gets the invite id.
Date	getLastDate() Gets the last use date.
Set<OriginInfo>	getOrigins() Gets the origins (direct users and groups involved in the call).
IdentityInfo	getOwner() Gets the owner.
Set<UserInfo>	getParticipants() Gets the participants (actual users for the call).
String	getProviderType() Gets the provider type.
Date	getStartDate() Gets the start date.
String	getState() Gets the state.
String	getTitle() Gets the title.
void	removeParticipant(UserInfo part) Removes the participant.
void	removeParticipants(Collection<UserInfo> parts) Removes the participants.
void	setEndDate(Date endDate) Sets the end date.
void	setInviteId(String inviteId) Sets the invite id.
void	setLastDate(Date lastDate) Sets the last use date.
void	setStartDate(Date startDate) Sets the start date.
void	setState(String state) Sets the state.
String	toJSON() Return JSON representation of this call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.exoplatform.services.log.Log LOG

The Constant LOG.

id

protected final String id

The id.

title

protected final String title

The title.

participants

protected final Set<UserInfo> participants

The participants.

origins

protected final Set<OriginInfo> origins

The origins.

owner

protected final IdentityInfo owner

The owner.

providerType

protected final String providerType

The provider type.

state

protected String state

The state.

lastDate

protected Date lastDate

The last date.

startDate

protected Date startDate

The start date.

endDate

protected Date endDate

The end date.

inviteId

protected String inviteId

The invite id.

Constructor Detail

CallInfo

public CallInfo(String id,
                String title,
                IdentityInfo owner,
                String providerType)

Instantiates a new call info.

Parameters:

id - the id

title - the title

owner - the owner

providerType - the provider type

Method Detail

getId

public String getId()

Gets the id.

Returns:

the id

getTitle

public String getTitle()

Gets the title. Can be null.

Returns:

the title or null

getParticipants

public Set<UserInfo> getParticipants()

Gets the participants (actual users for the call).

Returns:

the participants

getOrigins

public Set<OriginInfo> getOrigins()

Gets the origins (direct users and groups involved in the call).

Returns:

the origins

addOrigins

public void addOrigins(Collection<OriginInfo> origins)

Adds the origins.

Parameters:

origins - the origins

addOrigin

public void addOrigin(OriginInfo origin)

Adds the origin.

Parameters:

origin - the origin

getOwner

public IdentityInfo getOwner()

Gets the owner.

Returns:

the owner

getProviderType

public String getProviderType()

Gets the provider type.

Returns:

the provider type

addParticipants

public void addParticipants(Collection<UserInfo> parts)

Adds the participants. This method will add only if no such participant already exists (like Set works).

Parameters:

parts - the parts

addParticipant

public void addParticipant(UserInfo part)

Adds the participant. This method will add only if no such participant already exists (like Set works).

Parameters:

part - the part

removeParticipants

public void removeParticipants(Collection<UserInfo> parts)

Removes the participants.

Parameters:

parts - the parts

removeParticipant

public void removeParticipant(UserInfo part)

Removes the participant.

Parameters:

part - the part

getState

public String getState()

Gets the state.

Returns:

the state

setState

public void setState(String state)

Sets the state.

Parameters:

state - the new state

getLastDate

public Date getLastDate()

Gets the last use date.

Returns:

the lastDate

setLastDate

public void setLastDate(Date lastDate)

Sets the last use date.

Parameters:

lastDate - the date to set

getInviteId

public String getInviteId()

Gets the invite id.

Returns:

the invite id

setInviteId

public void setInviteId(String inviteId)

Sets the invite id.

Parameters:

inviteId - the new invite id

getStartDate

public Date getStartDate()

Gets the start date.

Returns:

the startDate

setStartDate

public void setStartDate(Date startDate)

Sets the start date.

Parameters:

startDate - the startDate to set

getEndDate

public Date getEndDate()

Gets the end date.

Returns:

the endDate

setEndDate

public void setEndDate(Date endDate)

Sets the end date.

Parameters:

endDate - the endDate to set

toJSON

public String toJSON()
              throws org.exoplatform.ws.frameworks.json.impl.JsonException

Return JSON representation of this call.

Returns:

the string

Throws:

org.exoplatform.ws.frameworks.json.impl.JsonException - the json exception