OSID Logo
OSID Specifications
room construction package
Version 3.1.0
Interfaceosid.room.construction.ProjectSearch
Implementsosid.OsidSearch
Used Byosid.room.construction.ProjectSearchSession
Description

The search interface for governing project searches.

MethodsearchAmongProjects
Description

Execute this search among the given list of projects.

Parametersosid.id.IdListProjectIds list of projects
ErrorsNULL_ARGUMENT ProjectIds is null
Compliancemandatory This method must be implemented.
MethodorderProjectResults
Description

Specify an ordering to the search results.

Parametersosid.room.construction.ProjectSearchOrderprojectSearchOrder project search order
ErrorsNULL_ARGUMENT projectSearchOrder is null
UNSUPPORTED projectSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetProjectSearchRecord
Description

Gets the search record corresponding to the given project search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeprojectSearchRecordType a project search record type
Returnosid.room.construction.records.ProjectSearchRecord the project search record
ErrorsNULL_ARGUMENT projectSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(projectSearchRecordType) is false
Compliancemandatory This method must be implemented.