com.sap.ip.collaboration.room.api

Interface IRoomInfoReader

All Known Subinterfaces:

IRoomInfo

public interface IRoomInfoReader

Method Summary

String	getAdminRoleName() Get the name of the admin room role.
String[]	getAllRoomParameterNames() Get all room parameter names of the room
IRoomParameterValue[]	getAllRoomParameters() Get all room parameters of the room
String[]	getAllRoomUserIds() Get the ids of all users of this collaboration room.
IRoomCategory[]	getCategories() Get the categories assigned to the room
String	getDescription() Get the description of the room
String	getId() Get the id of the room
String	getInitialRoleName() Get the name of the initial room role.
String	getName() Get the name of the room
String	getOwnerId() Get the uniqueID of the room owner
RoomPrivacyType	getPrivacy() Get the privacy type of the room (i.e.
IRoomGroups	getRoomGroups() Get an instance of IRoomGroups which contains the IDs of all User Management Groups and PrincipalSets related to this room.
IRoomParameterValue	getRoomParameter(String paramName) Get a specific room parameter
IRoomUsers	getRoomUsers() Get all Users who are member of any room role in this collaboration room.
String	getStructureRid() Get the RID of the structure of the room
String	getTemplateDescription() Get the template description of the room
String	getTemplateName() Get the template name of the room
IRoomRole[]	getUserRoles(String userId) Get the room roles for a specific user in this collaboration room
boolean	hasPublicRole() Check if there is a public role in the room If there is no public role in the room only members of the room have access to the room and its public area.

Method Detail

getId

public String getId()

Get the id of the room

Returns:

the id of the room

getName

public String getName()

Get the name of the room

Returns:

the name of the room

getDescription

public String getDescription()

Get the description of the room

Returns:

the description of the room

getTemplateName

public String getTemplateName()

Get the template name of the room

Returns:

the template name of the room

getTemplateDescription

public String getTemplateDescription()

Get the template description of the room

Returns:

the template description of the room

getStructureRid

public String getStructureRid()

Get the RID of the structure of the room

Returns:

the RID of the structure of the room

getCategories

public IRoomCategory[] getCategories()

Get the categories assigned to the room

Returns:

an Array containing the categories assigned to the room

getOwnerId

public String getOwnerId()

Get the uniqueID of the room owner

Returns:

the uniqueID of the room owner

getPrivacy

public RoomPrivacyType getPrivacy()

Get the privacy type of the room (i.e. Community, Listed Room, Unlisted Room)

Returns:

the privacy type of the room

getInitialRoleName

public String getInitialRoleName()

Get the name of the initial room role. The initial role is used for new members of a community (self registration).

Returns:

the name of the initial room role

getAdminRoleName

public String getAdminRoleName()

Get the name of the admin room role.

Returns:

the name of the admin room role

hasPublicRole

public boolean hasPublicRole()

Check if there is a public role in the room If there is no public role in the room only members of the room have access to the room and its public area.

Returns:

true if there is a public role in the room, false otherwise

getAllRoomParameterNames

public String[] getAllRoomParameterNames()

Get all room parameter names of the room

Returns:

Array containing all room parameter names

getAllRoomParameters

public IRoomParameterValue[] getAllRoomParameters()

Get all room parameters of the room

Returns:

Array containing all room parameters

getRoomParameter

public IRoomParameterValue getRoomParameter(String paramName)

Get a specific room parameter

Parameters:

paramName - the name of the room parameter

Returns:

the room parameter with the given name

getRoomUsers

public IRoomUsers getRoomUsers()

Get all Users who are member of any room role in this collaboration room.

Returns:

IRoomUsers object which holds all members of the room

getAllRoomUserIds

public String[] getAllRoomUserIds()

Get the ids of all users of this collaboration room. This is not the list of users who are currently online in the room. The returned Array contains all users who have access to this room.

Returns:

Array containing the unique ids of all users who are assigned to any room role in this room.

getUserRoles

public IRoomRole[] getUserRoles(String userId)

Get the room roles for a specific user in this collaboration room

Parameters:

userId - the uniqueId of the user

Returns:

Array of type IRoomRole containing all room roles the given user is member of in this room.

getRoomGroups

public IRoomGroups getRoomGroups()

Get an instance of IRoomGroups which contains the IDs of all User Management Groups and PrincipalSets related to this room.

Returns:

IRoomGroups instance