public interface IRoomsSearch
The Rooms Search API provides methods to search and find rooms matching application defined filter criteria. Note: The methods provided by this API only work correctly if useTRex is enabled in the Rooms Search Configuration and if all rooms are indexed in the configured index.
This interface is part of the Rooms API. It is public to all customers.
The entry point for performing a search for rooms is the
IRoomsSearchFactory
. Using this factory
applications can define their own search criteria and perform a search.
As a result they get back an instance of IRoomsSearch which provides
access to the results of the performed search.
Modifier and Type | Method and Description |
---|---|
IRoomsSearch |
and(IRoomsSearch searchInstance)
Using this method the current search criteria can be AND-related
with another instance of IRoomsSearch before calling
searchRooms() |
IRoom[] |
getSearchResultAsRooms(int startRow,
int numberOfRows)
If
searchRooms() has not been called before this method
performs the search and returns the requested search results as instances of
IRoom |
ISearchSession |
getSearchResultAsSession()
If
searchRooms() has not been called before this method
performs the search and returns an instance of ISearchSession . |
ITypedResourceList |
getSearchResultAsTRL(int startRow,
int numberOfRows)
If
searchRooms() has not been called before this method
performs the search and returns the requested search results as an instance of
ITypedResourceList |
int |
getTotalNumberOfRooms()
This method should be called after performing the actual search.
|
IRoomsSearch |
not()
Using this method the current search criteria can be inverted
before calling
searchRooms() |
IRoomsSearch |
or(IRoomsSearch searchInstance)
Using this method the current search criteria can be OR-related
with another instance of IRoomsSearch before calling
searchRooms() |
IRoomsSearch |
searchRooms()
Performs the search with the search criteria currently defined in this instance.
|
IRoomsSearch not() throws WcmException
searchRooms()
WcmException
- WcmExceptionIRoomsSearch and(IRoomsSearch searchInstance) throws WcmException
searchRooms()
searchInstance
- searchInstanceWcmException
- WcmExceptionIRoomsSearch or(IRoomsSearch searchInstance) throws WcmException
searchRooms()
searchInstance
- searchInstanceWcmException
- WcmExceptionIRoomsSearch searchRooms() throws WcmException
WcmException
- WcmExceptionISearchSession getSearchResultAsSession() throws WcmException
searchRooms()
has not been called before this method
performs the search and returns an instance of ISearchSession
.
The results of the search can then be accessed through this object.ISearchSession
WcmException
- WcmExceptionIRoom[] getSearchResultAsRooms(int startRow, int numberOfRows) throws WcmException
searchRooms()
has not been called before this method
performs the search and returns the requested search results as instances of
IRoom
startRow
- the position of the first result within the complete (sorted) result listnumberOfRows
- the number of results to be returnedIRoom
WcmException
- WcmExceptionITypedResourceList getSearchResultAsTRL(int startRow, int numberOfRows) throws WcmException
searchRooms()
has not been called before this method
performs the search and returns the requested search results as an instance of
ITypedResourceList
startRow
- the position of the first result within the complete (sorted) result listnumberOfRows
- the number of results to be returnedITypedResourceList
WcmException
- WcmExceptionint getTotalNumberOfRooms()
Access 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