com.sap.ip.collaboration.room.api

Interface IRoomProps

public interface IRoomProps

Interface providing technical properties of the room backend system. With a call of IRoomsSystem.getRoomProps() you will get an instance of IRoomProps. This interface gives you access to the configuration of the room backend system for use in other applications.

Method Summary

String	getCatsConfigPlugin() Get the name of the configuration plugin containing the room categories
String	getExtUrlPort() Get the Server Port for external room links
String	getExtUrlProtocol() Get the protocol String for external room links (i.e.
String	getExtUrlServerName() Get the Server Name for external room links
String	getIndexId() Get the ID of the TRex index for rooms
String	getNameSpace() Get the namespace which is used by the room backend system to create RF resources and resource properties
String	getPropAdminRole() Get the name of the room resource property containing the name of the room role which is used as admin role for users in the room.
String	getPropCategories() Get the name of the room resource property containing the room categories
String	getPropCreationDate() Get the name of the room resource property containing the room creation date
String	getPropDesc() Get the name of the room resource property containing the room description
String	getPropHasPublicRole() Get the name of the room resource property containing the boolean value whether the room has a public room role or not.
String	getPropHidden() Get the name of the room resource property containing the hidden status of the room
String	getPropId() Get the name of the room resource property containing the room id
String	getPropInitialRole() Get the name of the room resource property containing the name of the room role which is used as initial role for new users in the room.
String	getPropLastVisitDate() Get the name of the room resource property containing the room last visit date
String	getPropLock() Get the name of the room resource property containing the lock status of the room
String	getPropName() Get the name of the room resource property containing the room name
String	getPropOwner() Get the name of the room resource property containing the room owner
String	getPropOwnerDisplayName() Get the name of the room resource property containing the displayname of the room owner
String	getPropOwnerFullAccess()
String	getPropParamDesc() Get the prefix of the name of the room resource properties containing the room parameter descriptions.
String	getPropParamHidden()
String	getPropParams() Get the name of the room resource property containing the names of the room parameters
String	getPropParamVal() Get the prefix of the name of the room resource properties containing the room parameter values.
String	getPropPrivacy() Get the name of the room resource property containing the room privacy
String	getPropRoleGroupId() Get the prefix for the room role group property containing the name of the room role goup in the UM
String	getPropRoleName() Get the name of the room role group property containing the name of the room role
String	getPropStoreIds() Get the name of the room resource property containing the room store ids
String	getPropStructureId() Get the name of the room resource property containing the room structure RID
String	getPropTemplateDesc() Get the name of the room resource property containing the room template description
String	getPropTemplateName() Get the name of the room resource property containing the room template name
String	getPropTemplateVersion()
String	getPropVersion() Get the name of the room resource property containing the room version
String	getRenderingNameSpace() Get the namespace which is used by the room ui to render rooms
String	getResContextAllowedRoomsList() Get the name of the resource context parameter holding the list of rooms the user is allowed to enter
String	getResContextAllRoomsAllowed() Get the name of the resource context parameter holding the flag whether a user is allowed to enter ALL rooms in the list
String	getResourceTypeRoom() Get the resource type of the room resources
String	getResourceTypeTemplate() Get the resource type of the content template resources
String	getRoomRepositoryPrefix() Get the repository prefix of the repository containing the room resources
String	getServiceUser() Get the name service user used by the room backend system to create/access room resources
String	getStructureLinkName() Get the name of the room structure links
String	getStructureRepositoryPrefix() Get the repository prefix of the repository containing the room structure resources
String	getUMPrincipleTypeRoomRole() Get the type of the IPrincipleSets for RoomRoles
boolean	getUseTrexSearch() Get the cobfiguration flag if TRex search should be used to find rooms.

Method Detail

getCatsConfigPlugin

public String getCatsConfigPlugin()

Get the name of the configuration plugin containing the room categories

Returns:

String containing the name of the config plugin

getNameSpace

public String getNameSpace()

Get the namespace which is used by the room backend system to create RF resources and resource properties

Returns:

String containing the namespace

getRenderingNameSpace

public String getRenderingNameSpace()

Get the namespace which is used by the room ui to render rooms

Returns:

String containing the namespace

getResourceTypeRoom

public String getResourceTypeRoom()

Get the resource type of the room resources

Returns:

String containing the resource type

getResourceTypeTemplate

public String getResourceTypeTemplate()

Get the resource type of the content template resources

Returns:

String containing the resource type

getUMPrincipleTypeRoomRole

public String getUMPrincipleTypeRoomRole()

Get the type of the IPrincipleSets for RoomRoles

Returns:

String containing the type

getResContextAllRoomsAllowed

public String getResContextAllRoomsAllowed()

Get the name of the resource context parameter holding the flag whether a user is allowed to enter ALL rooms in the list

Returns:

String containing the resource context parameter name

getResContextAllowedRoomsList

public String getResContextAllowedRoomsList()

Get the name of the resource context parameter holding the list of rooms the user is allowed to enter

Returns:

String containing the resource context parameter name

getServiceUser

public String getServiceUser()

Get the name service user used by the room backend system to create/access room resources

Returns:

String containing the name of service user

getRoomRepositoryPrefix

public String getRoomRepositoryPrefix()

Get the repository prefix of the repository containing the room resources

Returns:

String containing the rooms repository prefix

getStructureRepositoryPrefix

public String getStructureRepositoryPrefix()

Get the repository prefix of the repository containing the room structure resources

Returns:

String containing the room structure repository prefix

getStructureLinkName

public String getStructureLinkName()

Get the name of the room structure links

Returns:

String containing the link name

getExtUrlProtocol

public String getExtUrlProtocol()

Get the protocol String for external room links (i.e. "http://")

Returns:

String containing the protocol String

getExtUrlServerName

public String getExtUrlServerName()

Get the Server Name for external room links

Returns:

String containing the Server Name

getExtUrlPort

public String getExtUrlPort()

Get the Server Port for external room links

Returns:

String containing the Server Port

getPropId

public String getPropId()

Get the name of the room resource property containing the room id

Returns:

String containing the property name

getPropCreationDate

public String getPropCreationDate()

Get the name of the room resource property containing the room creation date

Returns:

String containing the property name

getPropVersion

public String getPropVersion()

Get the name of the room resource property containing the room version

Returns:

String containing the property name

getPropName

public String getPropName()

Get the name of the room resource property containing the room name

Returns:

String containing the property name

getPropDesc

public String getPropDesc()

Get the name of the room resource property containing the room description

Returns:

String containing the property name

getPropLock

public String getPropLock()

Get the name of the room resource property containing the lock status of the room

Returns:

String containing the property name

getPropHidden

public String getPropHidden()

Get the name of the room resource property containing the hidden status of the room

Returns:

String containing the property name

getPropOwnerFullAccess

public String getPropOwnerFullAccess()

getPropTemplateName

public String getPropTemplateName()

Get the name of the room resource property containing the room template name

Returns:

String containing the property name

getPropTemplateDesc

public String getPropTemplateDesc()

Get the name of the room resource property containing the room template description

Returns:

String containing the property name

getPropTemplateVersion

public String getPropTemplateVersion()

getPropStoreIds

public String getPropStoreIds()

Get the name of the room resource property containing the room store ids

Returns:

String containing the property name

getPropStructureId

public String getPropStructureId()

Get the name of the room resource property containing the room structure RID

Returns:

String containing the property name

getPropCategories

public String getPropCategories()

Get the name of the room resource property containing the room categories

Returns:

String containing the property name

getPropOwner

public String getPropOwner()

Get the name of the room resource property containing the room owner

Returns:

String containing the property name

getPropOwnerDisplayName

public String getPropOwnerDisplayName()

Get the name of the room resource property containing the displayname of the room owner

Returns:

String containing the property name

getPropPrivacy

public String getPropPrivacy()

Get the name of the room resource property containing the room privacy

Returns:

String containing the property name

getPropInitialRole

public String getPropInitialRole()

Get the name of the room resource property containing the name of the room role which is used as initial role for new users in the room.

Returns:

String containing the property name

getPropAdminRole

public String getPropAdminRole()

Get the name of the room resource property containing the name of the room role which is used as admin role for users in the room.

Returns:

String containing the property name

getPropHasPublicRole

public String getPropHasPublicRole()

Get the name of the room resource property containing the boolean value whether the room has a public room role or not.

Returns:

String containing the property name

getPropParams

public String getPropParams()

Get the name of the room resource property containing the names of the room parameters

Returns:

String containing the property name

getPropParamDesc

public String getPropParamDesc()

Get the prefix of the name of the room resource properties containing the room parameter descriptions. The prefix followed by the name of a room parameter is a valid resource property name.

Returns:

String containing the property name

getPropParamVal

public String getPropParamVal()

Get the prefix of the name of the room resource properties containing the room parameter values. The prefix followed by the name of a room parameter is a valid resource property name.

Returns:

String containing the property name

getPropParamHidden

public String getPropParamHidden()

getPropRoleName

public String getPropRoleName()

Get the name of the room role group property containing the name of the room role

Returns:

String containing the property name

getPropRoleGroupId

public String getPropRoleGroupId()

Get the prefix for the room role group property containing the name of the room role goup in the UM

Returns:

String containing the room role group prefix

getPropLastVisitDate

public String getPropLastVisitDate()

Get the name of the room resource property containing the room last visit date

Returns:

String containing the property name

getUseTrexSearch

public boolean getUseTrexSearch()

Get the cobfiguration flag if TRex search should be used to find rooms. Value true means: TRex should be used to find rooms. Value false means: CM PropertySearch should be used to find rooms

Returns:

boolean flag

getIndexId

public String getIndexId()

Get the ID of the TRex index for rooms

Returns:

String containing the index id