public interface LeaseSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
LeaseSearchOrderRecord |
getLeaseSearchOrderRecord(Type leaseRecordType)
Gets the lease search order record corresponding to the given lease
record Type.
|
RoomSearchOrder |
getRoomSearchOrder()
Gets the room search order.
|
ResourceSearchOrder |
getTenantSearchOrder()
Gets the tenant resource search order.
|
void |
orderByRoom(SearchOrderStyle style)
Specifies a preference for ordering the result set by the room.
|
void |
orderByTenant(SearchOrderStyle style)
Specifies a preference for ordering the result set by the owner.
|
boolean |
supportsRoomSearchOrder()
Tests if a room search order is available.
|
boolean |
supportsTenantSearchOrder()
Tests if a tenant resource search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByRoom(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRoomSearchOrder()
true
if a room search order is available,
false
otherwisemandatory
- This method must be implemented. RoomSearchOrder getRoomSearchOrder()
UnimplementedException
-
supportsRoomSearchOrder()
is false
optional
- This method must be implemented if
supportsRoomSearchOrder()
is true.
void orderByTenant(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTenantSearchOrder()
true
if an tenant search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getTenantSearchOrder()
UnimplementedException
-
supportsTenantSearchOrder()
is false
optional
- This method must be implemented if
supportsTenantSearchOrder()
is true.
LeaseSearchOrderRecord getLeaseSearchOrderRecord(Type leaseRecordType) throws OperationFailedException
leaseRecordType
- a lease record typeNullArgumentException
- leaseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(leaseRecordType)
is false
mandatory
- This method must be implemented.