OSID - osid.room.squatting.LeaseSearchOrder Service Interface Definition

Interface	osid.room.squatting.LeaseSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByRoom
Description	Specifies a preference for ordering the result set by the room.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomSearchOrder
Description	Tests if a room search order is available.
Return	`boolean`		`true` if a room search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRoomSearchOrder
Description	Gets the room search order.
Return	`osid.room.RoomSearchOrder`		the room search order
Errors	UNIMPLEMENTED		`supportsRoomSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRoomSearchOrder()` is `true.`
Method	orderByTenant
Description	Specifies a preference for ordering the result set by the owner.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTenantSearchOrder
Description	Tests if a tenant resource search order is available.
Return	`boolean`		`true` if an tenant search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTenantSearchOrder
Description	Gets the tenant resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsTenantSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTenantSearchOrder()` is `true.`
Method	getLeaseSearchOrderRecord
Description	Gets the lease search order record corresponding to the given lease record Type. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`leaseRecordType`	a lease record type
Return	`osid.room.squatting.records.LeaseSearchOrderRecord`		the lease search order record
Errors	NULL_ARGUMENT		`leaseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(leaseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.