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

The search interface for governing project searches.

MethodsearchAmongProjects
Description

Execute this search among the given list of projects.

Parametersosid.id.IdListProjectIdslist of projects
ErrorsNULL_ARGUMENT ProjectIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProjectResults
Description

Specify an ordering to the search results.

Parametersosid.room.construction.ProjectSearchOrderprojectSearchOrderproject search order
ErrorsNULL_ARGUMENT projectSearchOrder is null
UNSUPPORTED projectSearchOrder is not of this service
CompliancemandatoryThis 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.TypeprojectSearchRecordTypea project search record type
Returnosid.room.construction.records.ProjectSearchRecordthe project search record
ErrorsNULL_ARGUMENT projectSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(projectSearchRecordType) is false
CompliancemandatoryThis method must be implemented.