| Interface | osid.room.construction.RenovationSearchSession | ||
|---|---|---|---|
| Implements | osid.room.construction.RenovationQuerySession | ||
| Used By | osid.room.construction.RoomConstructionManager | ||
osid.room.construction.RoomConstructionProxyManager | |||
| Description |
This session provides methods for searching
getRenovationsByQuery() is the basic search
method and returns a list of Renovation elements.
A more advanced search may be performed with
getRenovationsBySearch() . It accepts a
RenovationSearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering.
getRenovationeBySearch() returns a
RenovationSearchResults that can be used to
access the resulting RenovationList or be used to
perform a search within the result set through
RenovationSearch .
Renovations may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getRenovationSearch | ||
| Description |
Gets a renovation search. | ||
| Return | osid.room.construction.RenovationSearch | the renovation search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationSearchOrder | ||
| Description |
Gets a renovation search order. The
| ||
| Return | osid.room.construction.RenovationSearchOrder | the renovation search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationsBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.room.construction.RenovationQuery | renovationQuery | the renovation query |
osid.room.construction.RenovationSearch | renovationSearch | the renovation search | |
| Return | osid.room.construction.RenovationSearchResults | the renovation search results | |
| Errors | NULL_ARGUMENT | renovationQuery or renovationSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | renovationQuery or renovationSearch is not of
this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRenovationQueryFromInspector | ||
| Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
| Parameters | osid.room.construction.RenovationQueryInspector | renovationQueryInspector | a query inspector |
| Return | osid.room.construction.RenovationQuery | the entry query | |
| Errors | NULL_ARGUMENT | renovationQueryInspector is null | |
| UNSUPPORTED | renovationQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |