org.osid.room.squatting

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

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

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

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

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 supportsRoomSearchOrder() is 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 an 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 supportsTenantSearchOrder() is 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.