net.java.sip.communicator.service.protocol
Interface ChatRoomConfigurationForm

All Known Implementing Classes:

ChatRoomConfigurationFormJabberImpl

public interface ChatRoomConfigurationForm

The ChatRoomConfigurationForm contains the chat room configuration. It's meant to be implemented by protocol providers in order to provide an access to the administration properties of a chat room. The GUI should be able to obtain this form from the chat room and provide the user with the user interface representation and the possibility to change it.
The ChatRoomConfigurationForm contains a list of ChatRoomConfigurationFormFields. Each field corresponds to a chat room configuration property.

Author:

Yana Stamcheva

Method Summary

Iterator<ChatRoomConfigurationFormField>	getConfigurationSet() Returns an Iterator over a set of ChatRoomConfigurationFormFields, containing the current configuration of the chat room.
void	submit() Submits the information in this configuration form to the server.

Method Detail

getConfigurationSet

Iterator<ChatRoomConfigurationFormField> getConfigurationSet()

Returns an Iterator over a set of ChatRoomConfigurationFormFields, containing the current configuration of the chat room. This method is meant to be used by bundles interested showing and changing the current chat room configuration.

Returns:

a list of ChatRoomConfigurationFormFields, containing the current configuration of the chat room

submit

void submit()
            throws OperationFailedException

Submits the information in this configuration form to the server.

Throws:

OperationFailedException - if the submit opeation do not succeed for some reason (e.g. a wrong value is provided for a property)