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

Modifier and Type	Method and Description
boolean	getAutoSendMail() Get the cobfiguration flag if the rooms framework should automatically send e-mails.
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
int	getFlushRetriesCreation() Get the number of retries when flushing the cRoom index after its creation.
int	getFlushRetriesOther() Get the number of retries when flushing the cRoom index after any operation (room owner changed, etc)
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	getPropArchivingState() Get the name of the room resource property containing the room archiving state.
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	getPropInvalid() Get the name of the resource property containing the validation status of light room directory html
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	getPropOIFBased() Get the name of the room resource property containing the OIF status of the room
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() Get the name of the room resource property containing the owner full access status of the room
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	getSearchIviewParamStructureRid() Get the name of the room content search iView parameter for the room structure rid
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	getUseLightRoomdirectory() Get the cobfiguration flag if Light Room Directory is enabled.
boolean	getUseTrexCache() Get the configuration flag if TRex cache should be used to find rooms.
boolean	getUseTrexSearch() Get the configuration flag if TRex search should be used to find rooms.

Method Detail

getCatsConfigPlugin

String getCatsConfigPlugin()

Get the name of the configuration plugin containing the room categories

Returns:

String containing the name of the config plugin

getNameSpace

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

String getRenderingNameSpace()

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

Returns:

String containing the namespace

getResourceTypeRoom

String getResourceTypeRoom()

Get the resource type of the room resources

Returns:

String containing the resource type

getResourceTypeTemplate

String getResourceTypeTemplate()

Get the resource type of the content template resources

Returns:

String containing the resource type

getUMPrincipleTypeRoomRole

String getUMPrincipleTypeRoomRole()

Get the type of the IPrincipleSets for RoomRoles

Returns:

String containing the type

getResContextAllRoomsAllowed

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

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

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

String getRoomRepositoryPrefix()

Get the repository prefix of the repository containing the room resources

Returns:

String containing the rooms repository prefix

getStructureRepositoryPrefix

String getStructureRepositoryPrefix()

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

Returns:

String containing the room structure repository prefix

getStructureLinkName

String getStructureLinkName()

Get the name of the room structure links

Returns:

String containing the link name

getExtUrlProtocol

String getExtUrlProtocol()

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

Returns:

String containing the protocol String

getExtUrlServerName

String getExtUrlServerName()

Get the Server Name for external room links

Returns:

String containing the Server Name

getExtUrlPort

String getExtUrlPort()

Get the Server Port for external room links

Returns:

String containing the Server Port

getPropId

String getPropId()

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

Returns:

String containing the property name

getPropCreationDate

String getPropCreationDate()

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

Returns:

String containing the property name

getPropVersion

String getPropVersion()

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

Returns:

String containing the property name

getPropName

String getPropName()

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

Returns:

String containing the property name

getPropDesc

String getPropDesc()

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

Returns:

String containing the property name

getPropLock

String getPropLock()

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

Returns:

String containing the property name

getPropHidden

String getPropHidden()

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

Returns:

String containing the property name

getPropOwnerFullAccess

String getPropOwnerFullAccess()

Get the name of the room resource property containing the owner full access status of the room

Returns:

String containing the property name

getPropOIFBased

String getPropOIFBased()

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

Returns:

String containing the property name

getPropTemplateName

String getPropTemplateName()

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

Returns:

String containing the property name

getPropTemplateDesc

String getPropTemplateDesc()

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

Returns:

String containing the property name

getPropTemplateVersion

String getPropTemplateVersion()

Returns:

property template version

getPropStoreIds

String getPropStoreIds()

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

Returns:

String containing the property name

getPropStructureId

String getPropStructureId()

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

Returns:

String containing the property name

getPropCategories

String getPropCategories()

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

Returns:

String containing the property name

getPropOwner

String getPropOwner()

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

Returns:

String containing the property name

getPropOwnerDisplayName

String getPropOwnerDisplayName()

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

Returns:

String containing the property name

getPropPrivacy

String getPropPrivacy()

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

Returns:

String containing the property name

getPropInitialRole

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

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

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

String getPropParams()

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

Returns:

String containing the property name

getPropParamDesc

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

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

String getPropParamHidden()

Returns:

property parameter hidden

getPropRoleName

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

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

String getPropLastVisitDate()

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

Returns:

String containing the property name

getUseTrexSearch

boolean getUseTrexSearch()

Get the configuration 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

getUseTrexCache

boolean getUseTrexCache()

Get the configuration flag if TRex cache should be used to find rooms.

Returns:

boolean flag

getIndexId

String getIndexId()

Get the ID of the TRex index for rooms

Returns:

String containing the index id

getSearchIviewParamStructureRid

String getSearchIviewParamStructureRid()

Get the name of the room content search iView parameter for the room structure rid

Returns:

the parameter name

getPropInvalid

String getPropInvalid()

Get the name of the resource property containing the validation status of light room directory html

Returns:

String containing the property name

getUseLightRoomdirectory

boolean getUseLightRoomdirectory()

Get the cobfiguration flag if Light Room Directory is enabled. Value true means: Light room directory is used instead of standard room directory. Value false means: Standard room directory will be used

Returns:

boolean flag

getAutoSendMail

boolean getAutoSendMail()

Get the cobfiguration flag if the rooms framework should automatically send e-mails. Value true means: Automatic e-mails are sent (e.g. invitation e-mail when a user is added to the room) Value false means: Automatic e-mails are not sent

Returns:

boolean flag

getPropArchivingState

String getPropArchivingState()

Get the name of the room resource property containing the room archiving state. The WCM namespace should be used to get this property (IWcmConst.SAP_WCM_NAMESPACE).

Returns:

the archiving state property name

getFlushRetriesCreation

int getFlushRetriesCreation()

Get the number of retries when flushing the cRoom index after its creation.

Returns:

the number of flush retries

getFlushRetriesOther

int getFlushRetriesOther()

Get the number of retries when flushing the cRoom index after any operation (room owner changed, etc)

Returns:

the number of flush retries