Interface PeriodSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PeriodSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PeriodQueryInspector	getPeriodQueryInspector()	Gets the inspector for the query to examine the periods used in the search.
PeriodList	getPeriods()	Gets the period list resulting from a search.
PeriodSearchResultsRecord	getPeriodSearchResultsRecord(Type periodSearchRecordType)	Gets the period search results record corresponding to the given period 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

getPeriods

PeriodList getPeriods()

Gets the period list resulting from a search.

Returns:

the period list

Throws:

IllegalStateException - the period list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPeriodQueryInspector

PeriodQueryInspector getPeriodQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getPeriodSearchResultsRecord

PeriodSearchResultsRecord getPeriodSearchResultsRecord(Type periodSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

periodSearchRecordType - a period search record type

Returns:

the period search results record

Throws:

NullArgumentException - periodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(periodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.