Interface PublisherSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PublisherSearch
extends OsidSearch

The search interface for governing publisher searches.

Method Summary

Modifier and Type	Method	Description
PublisherSearchRecord	getPublisherSearchRecord(Type publisherSearchRecordType)	Gets the publisher search record corresponding to the given publisher search record Type .
void	orderPublisherResults(PublisherSearchOrder publishersearchOrder)	Specify an ordering to the search results.
void	searchAmongPublishers(IdList publisherIds)	Execute this search among the given list of publishers.

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

searchAmongPublishers

void searchAmongPublishers(IdList publisherIds)

Execute this search among the given list of publishers.

Parameters:

publisherIds - list of publishers

Throws:

NullArgumentException - publisherIds is null

Compliance:

mandatory - This method must be implemented.

orderPublisherResults

void orderPublisherResults(PublisherSearchOrder publishersearchOrder)

Specify an ordering to the search results.

Parameters:

publishersearchOrder - publisher search order

Throws:

NullArgumentException - publishersearchOrder is null

UnsupportedException - publishersearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPublisherSearchRecord

PublisherSearchRecord getPublisherSearchRecord(Type publisherSearchRecordType)
                                        throws OperationFailedException

Gets the publisher search record corresponding to the given publisher search record Type . This method must be used to retrieve an object implementing the requested record.

Parameters:

publisherSearchRecordType - a publisher search record type

Returns:

the publisher search record

Throws:

NullArgumentException - publishersearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(publishersearchRecordType) is false

Compliance:

mandatory - This method must be implemented.