OSID - osid.room.BuildingSearchOrder Service Interface Definition

Interface	osid.room.BuildingSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidTemporalSearchOrder`
Used By	`osid.room.BuildingSearchOrder`
	`osid.room.BuildingSearchSession`
	`osid.room.BuildingSmartCampusSession`
	`osid.room.FloorSearchOrder`
	`osid.room.RoomSearchOrder`
	`osid.room.construction.ProjectSearchOrder`
	`osid.room.squatting.DeedSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByAddress
Description	Specifies a preference for ordering the result set by the address.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAddressSearchOrder
Description	Tests if an address order is available.
Return	`boolean`		`true` if an address search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAddressSearchOrder
Description	Gets the address search order.
Return	`osid.contact.AddressSearchOrder`		the address search order
Errors	UNIMPLEMENTED		`supportsAddressSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAddressSearchOrder()` is `true`.
Method	orderByOfficialName
Description	Specifies a preference for ordering the result set by the offical name.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByNumber
Description	Specifies a preference for ordering the result set by the building number.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByEnclosingBuilding
Description	Specifies a preference for ordering the result set by the subdivisions.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnclosingBuildingSearchOrder
Description	Tests if an enclosing building search order is available.
Return	`boolean`		`true` if a building search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEnclosingBuildingSearchOrder
Description	Gets the enclosing building search order.
Return	`osid.room.BuildingSearchOrder`		the building search order
Errors	UNIMPLEMENTED		`supportsEnclosingBuildingSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEnclosingBuildingSearchOrder()` is `true`.
Method	orderByGrossArea
Description	Specifies a preference for ordering the result set by the gross area.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBuildingSearchOrderRecord
Description	Gets the building search order record corresponding to the given building record Type. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`buildingRecordType`	a building record type
Return	`osid.room.records.BuildingSearchOrderRecord`		the building search order record
Errors	NULL_ARGUMENT		`buildingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(buildingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.