Interface PressSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface PressSearch
extends OsidSearch

The search interface for governing press searches.

Method Summary

Modifier and Type	Method	Description
PressSearchRecord	getPressSearchRecord(Type pressSearchRecordType)	Gets the press search record corresponding to the given press search record Type.
void	orderPressResults(PressSearchOrder pressSearchOrder)	Specify an ordering to the search results.
void	searchAmongPresses(IdList pressIds)	Execute this search among the given list of presses.

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

searchAmongPresses

void searchAmongPresses(IdList pressIds)

Execute this search among the given list of presses.

Parameters:

pressIds - list of presses

Throws:

NullArgumentException - pressIds is null

Compliance:

mandatory - This method must be implemented.

orderPressResults

void orderPressResults(PressSearchOrder pressSearchOrder)

Specify an ordering to the search results.

Parameters:

pressSearchOrder - press search order

Throws:

NullArgumentException - pressSearchOrder is null

UnsupportedException - pressSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getPressSearchRecord

PressSearchRecord getPressSearchRecord(Type pressSearchRecordType)
                                throws OperationFailedException

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

Parameters:

pressSearchRecordType - an press search record type

Returns:

the press search record

Throws:

NullArgumentException - pressSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pressSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.