OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.RenovationSearch
Implementsosid.OsidSearch
Description

The search interface for governing renovation searches.

MethodsearchAmongRenovations
Description

Execute this search among the given list of renovations.

Parametersosid.id.IdListrenovationIdslist of renovations
ErrorsNULL_ARGUMENT renovationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRenovationResults
Description

Specify an ordering to the search results.

Parametersosid.room.construction.RenovationSearchOrderrenovationSearchOrderrenovation search order
ErrorsNULL_ARGUMENT renovationSearchOrder is null
UNSUPPORTED renovationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRenovationSearchRecord
Description

Gets the dis[atch search record corresponding to the given renovation search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TyperenovationSearchRecordTypea renovation search record type
Returnosid.room.construction.records.RenovationSearchRecordthe renovation search record
ErrorsNULL_ARGUMENT renovationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(renovationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.