rocks.xmpp.extensions.muc.model

Class RoomInfoForm

java.lang.Object

rocks.xmpp.extensions.muc.model.RoomInfoForm

public final class RoomInfoForm
extends Object

Author:

Christian Schudt

Constructor Summary

Constructors

Constructor and Description
RoomInfoForm(DataForm dataForm)

Method Summary

Modifier and Type	Method and Description
List<Jid>	getContacts() Gets the contact addresses (normally, room owner or owners).
int	getCurrentNumberOfOccupants() Gets the current number of occupants in the room.
String	getDescription() Gets a short description.
String	getLanguage() Gets the natural language for room discussions.
String	getLdapGroup() Gets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.
URL	getLogs() Gets an URL for archived discussion logs.
int	getMaxHistoryMessages() Gets the maximum number of history messages returned by the room.
String	getSubject() Gets the current discussion topic.
boolean	isChangeSubjectAllowed() Indicates, whether the room subject can be modified by participants.
void	setChangeSubjectAllowed(boolean changeSubjectAllowed) Indicates, whether the room subject can be modified by participants.
void	setContacts(List<Jid> administrators) Gets the contact addresses (normally, room owner or owners).
void	setCurrentNumberOfOccupants(int currentNumberOfOccupants) Sets the current number of occupants in the room.
void	setDescription(String description) Sets a short description.
void	setLanguage(String language) Sets the natural language for room discussions.
void	setLdapGroup(String ldapGroup) Sets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.
void	setLogs(URL logs) Sets an URL for archived discussion logs.
void	setMaxHistoryMessages(int maxHistoryMessages) Sets the maximum number of history messages returned by the room.
void	setSubject(String subject) Sets the current discussion topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomInfoForm

public RoomInfoForm(DataForm dataForm)

Method Detail

getMaxHistoryMessages

public int getMaxHistoryMessages()

Gets the maximum number of history messages returned by the room.

Returns:

The maximum number of history messages returned by the room.

setMaxHistoryMessages

public void setMaxHistoryMessages(int maxHistoryMessages)

Sets the maximum number of history messages returned by the room.

Parameters:

maxHistoryMessages - The maximum number of history messages returned by the room.

getContacts

public List<Jid> getContacts()

Gets the contact addresses (normally, room owner or owners).

Returns:

The contact addresses.

setContacts

public void setContacts(List<Jid> administrators)

Gets the contact addresses (normally, room owner or owners).

Parameters:

administrators - The contact addresses.

getDescription

public String getDescription()

Gets a short description.

Returns:

The description.

setDescription

public void setDescription(String description)

Sets a short description.

Parameters:

description - The description.

getLanguage

public String getLanguage()

Gets the natural language for room discussions.

Returns:

The language.

setLanguage

public void setLanguage(String language)

Sets the natural language for room discussions.

Parameters:

language - The language.

getLdapGroup

public String getLdapGroup()

Gets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.

Returns:

The LDAP group.

setLdapGroup

public void setLdapGroup(String ldapGroup)

Sets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.

Parameters:

ldapGroup - LDAP group.

getLogs

public URL getLogs()

Gets an URL for archived discussion logs.

Returns:

The URL.

setLogs

public void setLogs(URL logs)

Sets an URL for archived discussion logs.

Parameters:

logs - The URL.

getCurrentNumberOfOccupants

public int getCurrentNumberOfOccupants()

Gets the current number of occupants in the room.

Returns:

The number of occupants.

setCurrentNumberOfOccupants

public void setCurrentNumberOfOccupants(int currentNumberOfOccupants)

Sets the current number of occupants in the room.

Parameters:

currentNumberOfOccupants - The number of occupants.

getSubject

public String getSubject()

Gets the current discussion topic.

Returns:

The topic.

setSubject

public void setSubject(String subject)

Sets the current discussion topic.

Parameters:

subject - The topic.

isChangeSubjectAllowed

public boolean isChangeSubjectAllowed()

Indicates, whether the room subject can be modified by participants.

Returns:

Whether the room subject can be modified by participants.

setChangeSubjectAllowed

public void setChangeSubjectAllowed(boolean changeSubjectAllowed)

Indicates, whether the room subject can be modified by participants.

Parameters:

changeSubjectAllowed - Whether the room subject can be modified by participants.