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

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

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.