OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.RenovationSearchSession
Implementsosid.room.construction.RenovationQuerySession
Description

This session provides methods for searching Renovation objects. The search query is constructed using the RenovationQuery. The renovation record Type also specifies the record for the renovation query.

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 RenovationQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetRenovationSearch
Description

Gets a renovation search.

Returnosid.room.construction.RenovationSearchthe renovation search
CompliancemandatoryThis method must be implemented.
MethodgetRenovationSearchOrder
Description

Gets a renovation search order. The RenovationSearchOrder is supplied to a RenovationSearch to specify the ordering of results.

Returnosid.room.construction.RenovationSearchOrderthe renovation search order
CompliancemandatoryThis method must be implemented.
MethodgetRenovationsBySearch
Description

Gets the search results matching the given search.

Parametersosid.room.construction.RenovationQueryrenovationQuerythe renovation query
osid.room.construction.RenovationSearchrenovationSearchthe renovation search
Returnosid.room.construction.RenovationSearchResultsthe renovation search results
ErrorsNULL_ARGUMENT renovationQuery or renovationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED renovationQuery or renovationSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRenovationQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an RenovationSearchResults.

Parametersosid.room.construction.RenovationQueryInspectorrenovationQueryInspectora query inspector
Returnosid.room.construction.RenovationQuerythe entry query
ErrorsNULL_ARGUMENT renovationQueryInspector is null
UNSUPPORTED renovationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.