com.sap.ip.collaboration.room.api

Interface IRoomsStructure

public interface IRoomsStructure

Interface describing the Rooms Structure. Its purpose is to link CM folders used by iViews to their room or room part. The structure is build by the room and the room extensions, and is used by entry point providers and search engines. The entry point providers use the structure to collect the folders of a room to provide them as entry points for cut, paste, move and copy operations inside or outside a room. Search engines use the structure to retrieve the information to which room a folder belongs.

Method Summary

Modifier and Type	Method and Description
void	addFolder(String parentId, String folderPath) Add a folder to the rooms structure.
IEntryPoint	getEntryPoint(String id, String name, String description, String providerName) Construct a virtual entry point.
IEntryPointList	getEntryPointChildren(IEntryPoint parentEntryPoint, String providerName) Retrieve the children of a virtual entrypoint node.
IProperty	getProperty(IPropertyName propertyName, IEntryPoint entryPoint) Returns name and description internally stored by the getEntryPoint method.
List	getRoomFolders(String roomId, boolean includeRoomPartFolders) Get the folders of a room
String	getRoomOfResource(String resourcePath) Get the room a resource belongs to
String	getRoomOfRoomPart(String roomPartId) Get the room a room part belongs to
List	getRoomPartFolders(String roomPartId) Get the folders of a room part
List	getRoomParts(String roomId) Get the room parts of a room
boolean	hasFolder(String folderPath) Check if a folder is added to the rooms structure
void	removeFolder(String folderPath) Remove a folder from the rooms structure.
void	setEntryPoint(String folderPath, boolean isEntryPoint) Sets the entry point flag for a folder that has been added to the structure.

Method Detail

addFolder

void addFolder(String parentId,
               String folderPath)
        throws RoomException

Add a folder to the rooms structure.

Parameters:

parentId - Id of the room or room part the folder belongs to

folderPath - Path of the folder

Throws:

RoomException - RoomException

hasFolder

boolean hasFolder(String folderPath)
           throws RoomException

Check if a folder is added to the rooms structure

Parameters:

folderPath - Path of the folder

Returns:

True is the folder is in the structure

Throws:

RoomException - RoomException

removeFolder

void removeFolder(String folderPath)
           throws RoomException

Remove a folder from the rooms structure.

Parameters:

folderPath - Path of the folder

Throws:

RoomException - RoomException

getRoomParts

List getRoomParts(String roomId)
           throws RoomException,
                  IncompleteOperationException

Get the room parts of a room

Parameters:

roomId - Id of the room

Returns:

List of room part ids

Throws:

RoomException - RoomException

IncompleteOperationException - IncompleteOperationException

getRoomFolders

List getRoomFolders(String roomId,
                    boolean includeRoomPartFolders)
             throws RoomException,
                    IncompleteOperationException

Get the folders of a room

Parameters:

roomId - Id of the room

includeRoomPartFolders - Return folders of the room parts of a room also, if true

Returns:

List of folder paths

Throws:

RoomException - RoomException

IncompleteOperationException - IncompleteOperationException

getRoomPartFolders

List getRoomPartFolders(String roomPartId)
                 throws RoomException,
                        IncompleteOperationException

Get the folders of a room part

Parameters:

roomPartId - Id of the room

Returns:

List of folder paths

Throws:

RoomException - RoomException

IncompleteOperationException - IncompleteOperationException

getRoomOfRoomPart

String getRoomOfRoomPart(String roomPartId)
                  throws RoomException

Get the room a room part belongs to

Parameters:

roomPartId - Id of the room

Returns:

Id of the room

Throws:

RoomException - RoomException

getRoomOfResource

String getRoomOfResource(String resourcePath)
                  throws RoomException

Get the room a resource belongs to

Parameters:

resourcePath - Path of the resource

Returns:

The roomId or null if not in a room

Throws:

RoomException - RoomException

getEntryPoint

IEntryPoint getEntryPoint(String id,
                          String name,
                          String description,
                          String providerName)

Construct a virtual entry point. This method internally stores name and description for the getProperty method.

Parameters:

id - Id of the entry point

name - Name of the entry point

description - Description of the entry point

providerName - Name of the entry point provider

Returns:

The virtual entry point

getEntryPointChildren

IEntryPointList getEntryPointChildren(IEntryPoint parentEntryPoint,
                                      String providerName)
                               throws RoomException,
                                      IncompleteOperationException

Retrieve the children of a virtual entrypoint node. The id of the parent must be the id of a room or a room part.

Parameters:

parentEntryPoint - Parent

providerName - Name of the entry point provider

Returns:

List of children

Throws:

RoomException - RoomException

IncompleteOperationException

getProperty

IProperty getProperty(IPropertyName propertyName,
                      IEntryPoint entryPoint)
               throws ResourceException

Returns name and description internally stored by the getEntryPoint method.

Parameters:

propertyName - Name of the property (only valid for name and description)

entryPoint - The entry point

Returns:

Name or description property or null

Throws:

ResourceException - ResourceException

setEntryPoint

void setEntryPoint(String folderPath,
                   boolean isEntryPoint)
            throws RoomException

Sets the entry point flag for a folder that has been added to the structure.

Parameters:

folderPath - Name of the property (only valid for name and description)

isEntryPoint - List a link to the folder in the getEntryPointChildren method if true

Throws:

RoomException - RoomException