public interface IRoomInfoReader
Modifier and Type | Method and Description |
---|---|
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[] |
getAllRoomPrincipalSetIds()
Get the ids of all principalSets assigned directly to this collaboration
room.
|
String[] |
getAllRoomUserIds()
Get the ids of all users assigned directly to 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
|
IRoomRole[] |
getPrincipalSetRoles(String setId)
Get the room roles for a specific principalSet in this collaboration room
|
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
|
IRoomPrincipals |
getRoomPrincipals()
Get all users and principalSets who are member of any room role in this
room.
|
IRoomUsers |
getRoomUsers()
Deprecated.
use
getRoomPrincipals() instead |
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.
|
boolean |
isOIFBased()
Check whether this room should use the OIF (object instance floorplan)
based navigation pattern.
|
String getId()
String getName()
String getDescription()
String getTemplateName()
String getTemplateDescription()
String getStructureRid()
IRoomCategory[] getCategories()
String getOwnerId()
RoomPrivacyType getPrivacy()
String getInitialRoleName()
String getAdminRoleName()
boolean hasPublicRole()
boolean isOIFBased()
String[] getAllRoomParameterNames()
IRoomParameterValue[] getAllRoomParameters()
IRoomParameterValue getRoomParameter(String paramName)
paramName
- the name of the room parameterIRoomUsers getRoomUsers()
getRoomPrincipals()
insteadGet all Users who are member of any room role in this collaboration room.
IRoomPrincipals getRoomPrincipals()
String[] getAllRoomUserIds()
String[] getAllRoomPrincipalSetIds()
IRoomRole[] getUserRoles(String userId)
userId
- the uniqueId of the userIRoomRole
containing all room
roles the given user is member of in this room.IRoomRole[] getPrincipalSetRoles(String setId)
setId
- the uniqueId of the principalSetIRoomRole
containing all room
roles the given principalSet is member of in this room.IRoomGroups getRoomGroups()
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-COLL
|
[sap.com] tc/kmc/coll/room
|
api
|
EP-KM-CRS
|
Copyright 2018 SAP AG Complete Copyright Notice