public interface FloorSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
BuildingSearchOrder |
getBuildingSearchOrder()
Gets the building order.
|
FloorSearchOrderRecord |
getFloorSearchOrderRecord(Type floorRecordType)
Gets the floor search order record corresponding to the given floor
record Type.
|
void |
orderByBuilding(SearchOrderStyle style)
Specifies a preference for ordering the result set by the building.
|
void |
orderByGrossArea(SearchOrderStyle style)
Specifies a preference for ordering the result set by the gross area.
|
void |
orderByNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by the building
number.
|
boolean |
supportsBuildingSearchOrder()
Tests if a building order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByBuilding(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsBuildingSearchOrder()
true
if a building order is available,
false
otherwisemandatory
- This method must be implemented. BuildingSearchOrder getBuildingSearchOrder()
UnimplementedException
-
supportsBuildingSearchOrder()
is false
optional
- This method must be implemented if
supportsBuildingSearchOrder()
is true.
void orderByNumber(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByGrossArea(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. FloorSearchOrderRecord getFloorSearchOrderRecord(Type floorRecordType) throws OperationFailedException
floorRecordType
- a floor record typeNullArgumentException
- floorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(floorRecordType)
is false
mandatory
- This method must be implemented.