Interface DocetSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface DocetSearch
extends OsidSearch

The search interface for governing docet searches.

Method Summary

Modifier and Type	Method	Description
DocetSearchRecord	getDocetSearchRecord(Type docetSearchRecordType)	Gets the docet search record corresponding to the given docet search record Type.
void	orderDocetResults(DocetSearchOrder docetSearchOrder)	Specify an ordering to the search results.
void	searchAmongDocets(IdList docetIds)	Execute this search among the given list of docets.

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

searchAmongDocets

void searchAmongDocets(IdList docetIds)

Execute this search among the given list of docets.

Parameters:

docetIds - list of docets

Throws:

NullArgumentException - docetIds is null

Compliance:

mandatory - This method must be implemented.

orderDocetResults

void orderDocetResults(DocetSearchOrder docetSearchOrder)

Specify an ordering to the search results.

Parameters:

docetSearchOrder - docet search order

Throws:

NullArgumentException - docetSearchOrder is null

UnsupportedException - docetSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getDocetSearchRecord

DocetSearchRecord getDocetSearchRecord(Type docetSearchRecordType)
                                throws OperationFailedException

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

Parameters:

docetSearchRecordType - a docet search record type

Returns:

the docet search record

Throws:

NullArgumentException - docetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(docetSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.