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

Modifier and Type	Method	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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.