org.osid.room.squatting

Interface LeaseSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface LeaseSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
LeaseQueryInspector	getLeaseQueryInspector() Gets the inspector for the query to examine the terns used in the search.
LeaseList	getLeases() Gets the lease list resulting from a search.
LeaseSearchResultsRecord	getLeaseSearchResultsRecord(Type leaseSearchRecordType) Gets the lease search results record corresponding to the given lease search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getLeases

LeaseList getLeases()

Gets the lease list resulting from a search.

Returns:

the lease list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getLeaseQueryInspector

LeaseQueryInspector getLeaseQueryInspector()

Gets the inspector for the query to examine the terns used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getLeaseSearchResultsRecord

LeaseSearchResultsRecord getLeaseSearchResultsRecord(Type leaseSearchRecordType)
                                                     throws OperationFailedException

Gets the lease search results record corresponding to the given lease search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

leaseSearchRecordType - a lease search record type

Returns:

the lease search results record

Throws:

NullArgumentException - LeaseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(leaseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.