com.sap.ip.collaboration.room.api
Interface IRoomCategoryFactory

public interface IRoomCategoryFactory

Interface describing the factory for room categories.

You can obtain instances of IRoomCategory using this factory.

You can use these instances to set the room categories when you create a new room. To do this you first have to use the IRoomCategoryFactory to create new category instances and then put them into the method call IRoomInfo.setCategories(IRoomCategory[])

See Also:

IRoomCategory

Method Summary

IRoomCategory	getDefaultRoomCategory() Get the default room category
IRoomCategory[]	getRoomCategories() Get all existing room categories in the system
IRoomCategory	getRoomCategory(java.lang.String name) Get a specific room category

Method Detail

getRoomCategories

public IRoomCategory[] getRoomCategories()

Get all existing room categories in the system

Returns:

Array containing all room categories

getRoomCategory

public IRoomCategory getRoomCategory(java.lang.String name)
                              throws NoSuchRoomCategoryException

Get a specific room category

Parameters:

name - the name of the category to be instanciated

Returns:

instance of the room category

Throws:

NoSuchRoomCategoryException - if there is no such room category configured in the backend system with the given name

getDefaultRoomCategory

public IRoomCategory getDefaultRoomCategory()
                                     throws NoSuchRoomCategoryException

Get the default room category

Returns:

instance of the default room category

Throws:

NoSuchRoomCategoryException - if there is no default room category configured in the backend system