Interface FrontOfficeSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FrontOfficeSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
FrontOfficeQueryInspector	getFrontOfficeQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
FrontOfficeList	getFrontOffices()	Gets the front office list resulting from a search.
FrontOfficeSearchResultsRecord	getFrontOfficeSearchResultsRecord(Type frontOfficeSearchRecordType)	Gets the fromt office search results record corresponding to the given front office search record Type .This method is used to retrieve an object implementing the requested record.

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

getFrontOffices

FrontOfficeList getFrontOffices()

Gets the front office list resulting from a search.

Returns:

the front office list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getFrontOfficeQueryInspector

FrontOfficeQueryInspector getFrontOfficeQueryInspector()

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

Returns:

the front office query inspector

Compliance:

mandatory - This method must be implemented.

getFrontOfficeSearchResultsRecord

FrontOfficeSearchResultsRecord getFrontOfficeSearchResultsRecord(Type frontOfficeSearchRecordType)
                                                          throws OperationFailedException

Gets the fromt office search results record corresponding to the given front office search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

frontOfficeSearchRecordType - a front office search record type

Returns:

the front office search results record

Throws:

NullArgumentException - frontOfficeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(frontOfficeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.