Interface DeedSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DeedSearch
extends OsidSearch

The search interface for governing deed searches.

Method Summary

Modifier and Type	Method	Description
DeedSearchRecord	getDeedSearchRecord(Type deedSearchRecordType)	Gets the search record corresponding to the given deed search record Type .
void	orderDeedResults(DeedSearchOrder deedSearchOrder)	Specify an ordering to the search results.
void	searchAmongDeeds(IdList DeedIds)	Execute this search among the given list of deeds.

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

searchAmongDeeds

void searchAmongDeeds(IdList DeedIds)

Execute this search among the given list of deeds.

Parameters:

DeedIds - list of deeds

Throws:

NullArgumentException - DeedIds is null

Compliance:

mandatory - This method must be implemented.

orderDeedResults

void orderDeedResults(DeedSearchOrder deedSearchOrder)

Specify an ordering to the search results.

Parameters:

deedSearchOrder - a deed search order

Throws:

NullArgumentException - deedSearchOrder is null

UnsupportedException - deedSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDeedSearchRecord

DeedSearchRecord getDeedSearchRecord(Type deedSearchRecordType)
                              throws OperationFailedException

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

Parameters:

deedSearchRecordType - a deed search record type

Returns:

the deed search record

Throws:

NullArgumentException - deedSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(deedSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.