public interface IRoomsStructure
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.
|
void addFolder(String parentId, String folderPath) throws RoomException
parentId
- Id of the room or room part the folder belongs tofolderPath
- Path of the folderRoomException
- RoomExceptionboolean hasFolder(String folderPath) throws RoomException
folderPath
- Path of the folderRoomException
- RoomExceptionvoid removeFolder(String folderPath) throws RoomException
folderPath
- Path of the folderRoomException
- RoomExceptionList getRoomParts(String roomId) throws RoomException, IncompleteOperationException
roomId
- Id of the roomRoomException
- RoomExceptionIncompleteOperationException
- IncompleteOperationExceptionList getRoomFolders(String roomId, boolean includeRoomPartFolders) throws RoomException, IncompleteOperationException
roomId
- Id of the roomincludeRoomPartFolders
- Return folders of the room parts of a room also, if trueRoomException
- RoomExceptionIncompleteOperationException
- IncompleteOperationExceptionList getRoomPartFolders(String roomPartId) throws RoomException, IncompleteOperationException
roomPartId
- Id of the roomRoomException
- RoomExceptionIncompleteOperationException
- IncompleteOperationExceptionString getRoomOfRoomPart(String roomPartId) throws RoomException
roomPartId
- Id of the roomRoomException
- RoomExceptionString getRoomOfResource(String resourcePath) throws RoomException
resourcePath
- Path of the resourceRoomException
- RoomExceptionIEntryPoint getEntryPoint(String id, String name, String description, String providerName)
id
- Id of the entry pointname
- Name of the entry pointdescription
- Description of the entry pointproviderName
- Name of the entry point providerIEntryPointList getEntryPointChildren(IEntryPoint parentEntryPoint, String providerName) throws RoomException, IncompleteOperationException
parentEntryPoint
- ParentproviderName
- Name of the entry point providerRoomException
- RoomExceptionIncompleteOperationException
IProperty getProperty(IPropertyName propertyName, IEntryPoint entryPoint) throws ResourceException
propertyName
- Name of the property (only valid for name and description)entryPoint
- The entry pointResourceException
- ResourceExceptionvoid setEntryPoint(String folderPath, boolean isEntryPoint) throws RoomException
folderPath
- Name of the property (only valid for name and description)isEntryPoint
- List a link to the folder in the getEntryPointChildren method if trueRoomException
- RoomExceptionAccess 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