rocks.xmpp.extensions.muc.model

Class RoomConfigurationForm

java.lang.Object

rocks.xmpp.extensions.muc.model.RoomConfigurationForm

public final class RoomConfigurationForm
extends Object

Author:

Christian Schudt

Constructor Summary

Constructors

Constructor and Description
RoomConfigurationForm(DataForm dataForm)

Method Summary

Modifier and Type	Method and Description
List<Jid>	getAdministrators() Gets the administrators.
Set<Role>	getAllowedRolesToSendPrivateMessages() Gets the roles that may send private messages.
String	getLanguage() Gets the natural language for room discussions.
int	getMaxHistoryMessages() Gets the maximum number of history messages returned by the room.
int	getMaxOccupants() Gets the maximum number of room occupants.
List<Jid>	getOwners() Gets the owners.
String	getPassword() Gets the room password.
URI	getPubSubNode() Gets the XMPP URI of associated publish-subscribe node.
Set<Role>	getRolesForWhichPresenceIsBroadcast() Gets the roles for which presence is broadcast.
Set<Role>	getRolesWhichMayDiscoverRealJids() Get the roles, which may discover real JIDs.
Set<Role>	getRolesWhichMayRetrieveMemberList() Gets the roles which may retrieve member list.
String	getRoomDescription() Gets a short description.
String	getRoomName() Gets the natural-language room name.
boolean	isAllowInvites() Indicates, whether to allow occupants to invite others.
boolean	isChangeSubjectAllowed() Indicates, whether to allow occupants to change subject.
boolean	isMembersOnly() Indicates, whether the room is members-only.
boolean	isModerated() Indicates, whether the room is moderated.
boolean	isPasswordProtected() Indicates, whether the room is password protected.
boolean	isPersistentRoom() Indicates, whether the room is persistent.
boolean	isPublicLoggingEnabled() Indicates, whether to enable public logging of room conversations.
boolean	isPublicRoom() Indicates, whether the room is public.
void	setAdministrators(List<Jid> administrators) Sets the administrators.
void	setAllowedRolesToSendPrivateMessages(Set<Role> roles) Sets the roles that may send private messages.
void	setAllowInvites(boolean allowInvites) Indicates, whether to allow occupants to invite others.
void	setChangeSubjectAllowed(boolean changeSubjectAllowed) Indicates, whether to allow occupants to change subject.
void	setLanguage(String language) Sets the natural language for room discussions.
void	setMaxHistoryMessages(int maxHistoryMessages) Sets the maximum number of history messages returned by the room.
void	setMaxOccupants(int maxOccupants) Sets the maximum number of room occupants.
void	setMembersOnly(boolean membersOnly) Indicates, whether the room is members-only.
void	setModerated(boolean moderated) Indicates, whether the room is moderated.
void	setOwners(List<Jid> owners) Sets the owners.
void	setPassword(String password) Sets the room password.
void	setPasswordProtected(boolean passwordProtected) Indicates, whether the room is password protected.
void	setPersistentRoom(boolean persistentRoom) Indicates, whether the room is persistent.
void	setPublicLoggingEnabled(boolean publicLoggingEnabled) Indicates, whether to enable public logging of room conversations.
void	setPublicRoom(boolean publicRoom) Indicates, whether the room is public.
void	setPubSubNode(URI pubSubNode) Sets the XMPP URI of associated publish-subscribe node.
void	setRolesForWhichPresenceIsBroadcast(Set<Role> roles) Sets the roles for which presence is broadcast.
void	setRolesWhichMayDiscoverRealJids(Set<Role> roles) Get the roles, which may discover real JIDs.
void	setRolesWhichMayRetrieveMemberList(Set<Role> roles) Sets the roles for which presence is broadcast.
void	setRoomDescription(String description) Sets a short description.
void	setRoomName(String description) Sets the natural-language room name.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomConfigurationForm

public RoomConfigurationForm(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.

getAllowedRolesToSendPrivateMessages

public Set<Role> getAllowedRolesToSendPrivateMessages()

Gets the roles that may send private messages.

Returns:

The roles.

setAllowedRolesToSendPrivateMessages

public void setAllowedRolesToSendPrivateMessages(Set<Role> roles)

Sets the roles that may send private messages.

Parameters:

roles - The roles.

isAllowInvites

public boolean isAllowInvites()

Indicates, whether to allow occupants to invite others.

Returns:

True, if occupants are allowed to invite others.

setAllowInvites

public void setAllowInvites(boolean allowInvites)

Indicates, whether to allow occupants to invite others.

Parameters:

allowInvites - True, if occupants are allowed to invite others.

isChangeSubjectAllowed

public boolean isChangeSubjectAllowed()

Indicates, whether to allow occupants to change subject.

Returns:

True, if occupants are allowed to change subject.

setChangeSubjectAllowed

public void setChangeSubjectAllowed(boolean changeSubjectAllowed)

Indicates, whether to allow occupants to change subject.

Parameters:

changeSubjectAllowed - True, if occupants are allowed to change subject.

isPublicLoggingEnabled

public boolean isPublicLoggingEnabled()

Indicates, whether to enable public logging of room conversations.

Returns:

True, if public logging of room conversations is enabled.

setPublicLoggingEnabled

public void setPublicLoggingEnabled(boolean publicLoggingEnabled)

Indicates, whether to enable public logging of room conversations.

Parameters:

publicLoggingEnabled - True, if public logging of room conversations is enabled.

getRolesWhichMayRetrieveMemberList

public Set<Role> getRolesWhichMayRetrieveMemberList()

Gets the roles which may retrieve member list.

Returns:

The roles which may retrieve member list.

setRolesWhichMayRetrieveMemberList

public void setRolesWhichMayRetrieveMemberList(Set<Role> roles)

Sets the roles for which presence is broadcast.

Parameters:

roles - The roles for which presence is broadcast.

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.

getPubSubNode

public URI getPubSubNode()

Gets the XMPP URI of associated publish-subscribe node.

Returns:

The URI.

setPubSubNode

public void setPubSubNode(URI pubSubNode)

Sets the XMPP URI of associated publish-subscribe node.

Parameters:

pubSubNode - The URI.

getMaxOccupants

public int getMaxOccupants()

Gets the maximum number of room occupants.

Returns:

The maximum number of room occupants.

setMaxOccupants

public void setMaxOccupants(int maxOccupants)

Sets the maximum number of room occupants.

Parameters:

maxOccupants - The maximum number of room occupants.

isMembersOnly

public boolean isMembersOnly()

Indicates, whether the room is members-only.

Returns:

True, if the room is members-only.

setMembersOnly

public void setMembersOnly(boolean membersOnly)

Indicates, whether the room is members-only.

Parameters:

membersOnly - True, if the room is members-only.

isModerated

public boolean isModerated()

Indicates, whether the room is moderated.

Returns:

True, if the room is moderated.

setModerated

public void setModerated(boolean moderated)

Indicates, whether the room is moderated.

Parameters:

moderated - True, if the room is moderated.

isPasswordProtected

public boolean isPasswordProtected()

Indicates, whether the room is password protected.

Returns:

True, if the room is password protected.

setPasswordProtected

public void setPasswordProtected(boolean passwordProtected)

Indicates, whether the room is password protected.

Parameters:

passwordProtected - True, if the room is password protected.

isPersistentRoom

public boolean isPersistentRoom()

Indicates, whether the room is persistent.

Returns:

True, if the room is persistent.

setPersistentRoom

public void setPersistentRoom(boolean persistentRoom)

Indicates, whether the room is persistent.

Parameters:

persistentRoom - True, if the room is persistent.

getRolesForWhichPresenceIsBroadcast

public Set<Role> getRolesForWhichPresenceIsBroadcast()

Gets the roles for which presence is broadcast.

Returns:

The roles for which presence is broadcast.

setRolesForWhichPresenceIsBroadcast

public void setRolesForWhichPresenceIsBroadcast(Set<Role> roles)

Sets the roles for which presence is broadcast.

Parameters:

roles - The roles for which presence is broadcast.

isPublicRoom

public boolean isPublicRoom()

Indicates, whether the room is public.

Returns:

True, if the room is public.

setPublicRoom

public void setPublicRoom(boolean publicRoom)

Indicates, whether the room is public.

Parameters:

publicRoom - True, if the room is public.

getAdministrators

public List<Jid> getAdministrators()

Gets the administrators.

Returns:

The administrators.

setAdministrators

public void setAdministrators(List<Jid> administrators)

Sets the administrators.

Parameters:

administrators - The administrators.

getRoomDescription

public String getRoomDescription()

Gets a short description.

Returns:

The description.

setRoomDescription

public void setRoomDescription(String description)

Sets a short description.

Parameters:

description - The description.

getRoomName

public String getRoomName()

Gets the natural-language room name.

Returns:

The room name.

setRoomName

public void setRoomName(String description)

Sets the natural-language room name.

Parameters:

description - The room name.

getOwners

public List<Jid> getOwners()

Gets the owners.

Returns:

The owners.

setOwners

public void setOwners(List<Jid> owners)

Sets the owners.

Parameters:

owners - The owners.

getPassword

public String getPassword()

Gets the room password.

Returns:

The password.

setPassword

public void setPassword(String password)

Sets the room password.

Parameters:

password - The password.

getRolesWhichMayDiscoverRealJids

public Set<Role> getRolesWhichMayDiscoverRealJids()

Get the roles, which may discover real JIDs.

Returns:

The roles, which may discover real JIDs.

setRolesWhichMayDiscoverRealJids

public void setRolesWhichMayDiscoverRealJids(Set<Role> roles)

Get the roles, which may discover real JIDs.

Parameters:

roles - The roles, which may discover real JIDs.