Interface LeaseSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface LeaseSearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getEndReasonSearchOrder()	Gets the search order for a state.
void	orderByEndReason(SearchOrderStyle style)	Specifies a preference for ordering the results by the end reason state.
boolean	supportsEndReasonSearchOrder()	Tests if a StateSearchOrder is available.

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

orderByRoom

void orderByRoom(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRoomSearchOrder

boolean supportsRoomSearchOrder()

Tests if a room search order is available.

Returns:

true if a room search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRoomSearchOrder

RoomSearchOrder getRoomSearchOrder()

Gets the room search order.

Returns:

the room search order

Throws:

UnimplementedException - supportsRoomSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsRoomSearchOrder()} is {@code true} .

orderByTenant

void orderByTenant(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsTenantSearchOrder

boolean supportsTenantSearchOrder()

Tests if a tenant resource search order is available.

Returns:

true if a tenant search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTenantSearchOrder

ResourceSearchOrder getTenantSearchOrder()

Gets the tenant resource search order.

Returns:

the resource search order

Throws:

UnimplementedException - supportsTenantSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsTenantSearchOrder()} is {@code true} .

getLeaseSearchOrderRecord

LeaseSearchOrderRecord getLeaseSearchOrderRecord(Type leaseRecordType)
                                          throws OperationFailedException

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

Parameters:

leaseRecordType - a lease record type

Returns:

the lease search order record

Throws:

NullArgumentException - leaseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(leaseRecordType) is false

Compliance:

mandatory - This method must be implemented.