Interface AgencySearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AgencySearch
extends OsidSearch

The interface for governing agency searches.

Method Summary

Modifier and Type	Method	Description
AgencySearchRecord	getAgencySearchRecord(Type agencySearchRecordType)	Gets the record corresponding to the given agency search record Type .
void	orderAgencyResults(AgencySearchOrder agencySearchOrder)	Specify an ordering to the search results.
void	searchAmongAgencies(IdList agencyIds)	Execute this search among the given list of agencies.

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

searchAmongAgencies

void searchAmongAgencies(IdList agencyIds)

Execute this search among the given list of agencies.

Parameters:

agencyIds - list of agencies

Throws:

NullArgumentException - agencyIds is null

Compliance:

mandatory - This method must be implemented.

orderAgencyResults

void orderAgencyResults(AgencySearchOrder agencySearchOrder)

Specify an ordering to the search results.

Parameters:

agencySearchOrder - agency search order

Throws:

NullArgumentException - agencySearchOrder is null

UnsupportedException - agencySearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAgencySearchRecord

AgencySearchRecord getAgencySearchRecord(Type agencySearchRecordType)
                                  throws OperationFailedException

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

Parameters:

agencySearchRecordType - an agency search record type

Returns:

the agency search record

Throws:

NullArgumentException - agencySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agencySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.