OSID Logo
OSID Specifications
room construction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.construction.ProjectSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByBuilding
Description

Specifies a preference for ordering the result set by the building.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsBuildingSearchOrder
Description

Tests if a building search order is available.

Returnboolean true if a building search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBuildingSearchOrder
Description

Gets the building search order.

Returnosid.room.BuildingSearchOrderthe building search order
ErrorsUNIMPLEMENTED supportsBuildingSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsBuildingSearchOrder() is true.
MethodorderByCost
Description

Specifies a preference for ordering the result set by the cost.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetProjectSearchOrderRecord
Description

Gets the project search order record corresponding to the given project record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeprojectRecordTypea project record type
Returnosid.room.construction.records.ProjectSearchOrderRecordthe project search order record
ErrorsNULL_ARGUMENT projectRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(projectRecordType) is false
CompliancemandatoryThis method must be implemented.