Interface LeaseSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface LeaseSearch
extends OsidSearch

The search interface for governing lease searches.

Method Summary

Modifier and Type	Method	Description
LeaseSearchRecord	getLeaseSearchRecord(Type leaseSearchRecordType)	Gets the dis[atch search record corresponding to the given lease search record Type .
void	orderLeaseResults(LeaseSearchOrder leaseSearchOrder)	Specify an ordering to the search results.
void	searchAmongLeases(IdList leaseIds)	Execute this search among the given list of leases.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongLeases

void searchAmongLeases(IdList leaseIds)

Execute this search among the given list of leases.

Parameters:

leaseIds - list of leases

Throws:

NullArgumentException - leaseIds is null

Compliance:

mandatory - This method must be implemented.

orderLeaseResults

void orderLeaseResults(LeaseSearchOrder leaseSearchOrder)

Specify an ordering to the search results.

Parameters:

leaseSearchOrder - lease search order

Throws:

NullArgumentException - leaseSearchOrder is null

UnsupportedException - leaseSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getLeaseSearchRecord

LeaseSearchRecord getLeaseSearchRecord(Type leaseSearchRecordType)
                                throws OperationFailedException

Gets the dis[atch search 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 record

Throws:

NullArgumentException - leaseSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(leaseSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.