org.osid.workflow

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

Methods

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

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

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 - a 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.