Interface OfficeSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface OfficeSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
OfficeQueryInspector	getOfficeQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
OfficeList	getOffices()	Gets the office list resulting from a search.
OfficeSearchResultsRecord	getOfficeSearchResultsRecord(Type officeSearchRecordType)	Gets the office search results record corresponding to the given 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

getOffices

OfficeList getOffices()

Gets the office list resulting from a search.

Returns:

the office list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getOfficeQueryInspector

OfficeQueryInspector getOfficeQueryInspector()

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

Returns:

the office query inspector

Compliance:

mandatory - This method must be implemented.

getOfficeSearchResultsRecord

OfficeSearchResultsRecord getOfficeSearchResultsRecord(Type officeSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

officeSearchRecordType - an office search record type

Returns:

the office search results record

Throws:

NullArgumentException - officeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(officeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.