OSID Logo
OSID Specifications
room construction package
Version 3.1.0
Interfaceosid.room.construction.ProjectSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
Used Byosid.room.construction.ProjectSearchSession
osid.room.construction.ProjectSmartCampusSession
Description

An interface for specifying the ordering of search results.

MethodorderByBuilding
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetBuildingSearchOrder
Description

Gets the building search order.

Returnosid.room.BuildingSearchOrder the building search order
ErrorsUNIMPLEMENTED supportsBuildingSearchOrder() is false
Complianceoptional This method must be implemented if supportsBuildingSearchOrder() is true.
MethodorderByCost
Description

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

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypeprojectRecordType a project record type
Returnosid.room.construction.records.ProjectSearchOrderRecord the project search order record
ErrorsNULL_ARGUMENT projectRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(projectRecordType) is false
Compliancemandatory This method must be implemented.