org.osid.authentication

Interface AgencySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AgencySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
AgencyList	getAgencies() Gets the agency list resultrng from a search.
AgencyQueryInspector	getAgencyQueryInspector() Gets the inspector for the query to examine the terms used in the search.
AgencySearchResultsRecord	getAgencySearchResultsRecord(Type agencySearchRecordType) Gets the record corresponding to the given agency search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getAgencies

AgencyList getAgencies()

Gets the agency list resultrng from a search.

Returns:

the agency list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAgencyQueryInspector

AgencyQueryInspector getAgencyQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getAgencySearchResultsRecord

AgencySearchResultsRecord getAgencySearchResultsRecord(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 results record

Throws:

NullArgumentException - agencySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(agencySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.