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

java.lang.String	getCatsConfigPlugin() Get the name of the configuration plugin containing the room categories
java.lang.String	getExtUrlPort() Get the Server Port for external room links
java.lang.String	getExtUrlProtocol() Get the protocol String for external room links (i.e.
java.lang.String	getExtUrlServerName() Get the Server Name for external room links
java.lang.String	getNameSpace() Get the namespace which is used by the room backend system to create RF resources and resource properties
java.lang.String	getPropCategories() Get the name of the room resource property containing the room categories
java.lang.String	getPropCreationDate() Get the name of the room resource property containing the room creation date
java.lang.String	getPropDesc() Get the name of the room resource property containing the room description
java.lang.String	getPropHasPublicRole() Get the name of the room resource property containing the boolean value whether the room has a public room role or not.
java.lang.String	getPropHidden() Get the name of the room resource property containing the hidden status of the room
java.lang.String	getPropId() Get the name of the room resource property containing the room id
java.lang.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.
java.lang.String	getPropLock() Get the name of the room resource property containing the lock status of the room
java.lang.String	getPropName() Get the name of the room resource property containing the room name
java.lang.String	getPropOwner() Get the name of the room resource property containing the room owner
java.lang.String	getPropOwnerFullAccess()
java.lang.String	getPropParamDesc() Get the prefix of the name of the room resource properties containing the room parameter descriptions.
java.lang.String	getPropParamHidden()
java.lang.String	getPropParams() Get the name of the room resource property containing the names of the room parameters
java.lang.String	getPropParamVal() Get the prefix of the name of the room resource properties containing the room parameter values.
java.lang.String	getPropPrivacy() Get the name of the room resource property containing the room privacy
java.lang.String	getPropRoleName() Get the name of the room role group property containing the name of the room role
java.lang.String	getPropStoreIds() Get the name of the room resource property containing the room store ids
java.lang.String	getPropStructureId() Get the name of the room resource property containing the room structure RID
java.lang.String	getPropTemplateDesc() Get the name of the room resource property containing the room template description
java.lang.String	getPropTemplateName() Get the name of the room resource property containing the room template name
java.lang.String	getPropTemplateVersion()
java.lang.String	getPropVersion() Get the name of the room resource property containing the room version
java.lang.String	getResContextAllowedRoomsList() Get the name of the resource context parameter holding the list of rooms the user is allowed to enter
java.lang.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
java.lang.String	getResourceTypeRoom() Get the resource type of the room resources
java.lang.String	getResourceTypeTemplate() Get the resource type of the content template resources
java.lang.String	getRoomRepositoryPrefix() Get the repository prefix of the repository containing the room resources
java.lang.String	getServiceUser() Get the name service user used by the room backend system to create/access room resources
java.lang.String	getStructureLinkName() Get the name of the room structure links
java.lang.String	getStructureRepositoryPrefix() Get the repository prefix of the repository containing the room structure resources
java.lang.String	getUMPrincipleTypeRoomRole() Get the type of the IPrincipleSets for RoomRoles

Method Detail

getCatsConfigPlugin

public java.lang.String getCatsConfigPlugin()

Get the name of the configuration plugin containing the room categories

Returns:

String containing the name of the config plugin

getNameSpace

public java.lang.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

getResourceTypeRoom

public java.lang.String getResourceTypeRoom()

Get the resource type of the room resources

Returns:

String containing the resource type

getResourceTypeTemplate

public java.lang.String getResourceTypeTemplate()

Get the resource type of the content template resources

Returns:

String containing the resource type

getUMPrincipleTypeRoomRole

public java.lang.String getUMPrincipleTypeRoomRole()

Get the type of the IPrincipleSets for RoomRoles

Returns:

String containing the type

getResContextAllRoomsAllowed

public java.lang.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 java.lang.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 java.lang.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 java.lang.String getRoomRepositoryPrefix()

Get the repository prefix of the repository containing the room resources

Returns:

String containing the rooms repository prefix

getStructureRepositoryPrefix

public java.lang.String getStructureRepositoryPrefix()

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

Returns:

String containing the room structure repository prefix

getStructureLinkName

public java.lang.String getStructureLinkName()

Get the name of the room structure links

Returns:

String containing the link name

getExtUrlProtocol

public java.lang.String getExtUrlProtocol()

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

Returns:

String containing the protocol String

getExtUrlServerName

public java.lang.String getExtUrlServerName()

Get the Server Name for external room links

Returns:

String containing the Server Name

getExtUrlPort

public java.lang.String getExtUrlPort()

Get the Server Port for external room links

Returns:

String containing the Server Port

getPropId

public java.lang.String getPropId()

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

Returns:

String containing the property name

getPropCreationDate

public java.lang.String getPropCreationDate()

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

Returns:

String containing the property name

getPropVersion

public java.lang.String getPropVersion()

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

Returns:

String containing the property name

getPropName

public java.lang.String getPropName()

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

Returns:

String containing the property name

getPropDesc

public java.lang.String getPropDesc()

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

Returns:

String containing the property name

getPropLock

public java.lang.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 java.lang.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 java.lang.String getPropOwnerFullAccess()

getPropTemplateName

public java.lang.String getPropTemplateName()

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

Returns:

String containing the property name

getPropTemplateDesc

public java.lang.String getPropTemplateDesc()

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

Returns:

String containing the property name

getPropTemplateVersion

public java.lang.String getPropTemplateVersion()

getPropStoreIds

public java.lang.String getPropStoreIds()

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

Returns:

String containing the property name

getPropStructureId

public java.lang.String getPropStructureId()

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

Returns:

String containing the property name

getPropCategories

public java.lang.String getPropCategories()

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

Returns:

String containing the property name

getPropOwner

public java.lang.String getPropOwner()

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

Returns:

String containing the property name

getPropPrivacy

public java.lang.String getPropPrivacy()

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

Returns:

String containing the property name

getPropInitialRole

public java.lang.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

getPropHasPublicRole

public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.String getPropParamHidden()

getPropRoleName

public java.lang.String getPropRoleName()

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

Returns:

String containing the property name