OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomSearchOrder
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 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.
MethodorderByFloor
Description

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

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

Tests if a floor order is available.

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

Gets the floor search order.

Returnosid.room.FloorSearchOrderthe floor search order
ErrorsUNIMPLEMENTED supportsFloorSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsFloorSearchOrder() is true.
MethodorderByEnclosingRoom
Description

Specifies a preference for ordering the result set by the enclosing room.

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

Tests if a room search order is available.

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

Gets the room search order.

Returnosid.room.RoomSearchOrderthe enclosing room search order
ErrorsUNIMPLEMENTED supportsEnclosingRoomSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsEnclosingRoomSearchOrder() is true.
MethodorderByRoomNumber
Description

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

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

Specifies a preference for ordering the result set by the room code.

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

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

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

Specifies a preference for ordering the result set by the room occupancy limit.

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

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

Parametersosid.type.TyperoomRecordTypea room record type
Returnosid.room.records.RoomSearchOrderRecordthe room search order record
ErrorsNULL_ARGUMENT roomRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(roomRecordType) is false
CompliancemandatoryThis method must be implemented.