OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.FloorSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
osid.OsidSubjugateableSearchOrder
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 order is available.

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

Gets the building order.

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

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

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

Specifies a preference for ordering the result set by the gross area.

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

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

Parametersosid.type.TypefloorRecordTypea floor record type
Returnosid.room.records.FloorSearchOrderRecordthe floor search order record
ErrorsNULL_ARGUMENT floorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(floorRecordType) is false
CompliancemandatoryThis method must be implemented.