org.osid.calendaring.cycle

Interface CyclicTimePeriodSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CyclicTimePeriodSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CyclicTimePeriodQueryInspector	getCyclicTimePeriodQueryInspector() Gets the inspector for the query to examine the cyclic time periods used in the search.
CyclicTimePeriodList	getCyclicTimePeriods() Gets the cyclic time period list resulting from the search.
CyclicTimePeriodSearchResultsRecord	getCyclicTimePeriodSearchResultsRecord(Type cyclicTimePeriodSearchRecordType) Gets the cyclic time period search results record corresponding to the given cyclic time period 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

getCyclicTimePeriods

CyclicTimePeriodList getCyclicTimePeriods()

Gets the cyclic time period list resulting from the search.

Returns:

the cyclic time period list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodQueryInspector

CyclicTimePeriodQueryInspector getCyclicTimePeriodQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCyclicTimePeriodSearchResultsRecord

CyclicTimePeriodSearchResultsRecord getCyclicTimePeriodSearchResultsRecord(Type cyclicTimePeriodSearchRecordType)
                                                                           throws OperationFailedException

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

Parameters:

cyclicTimePeriodSearchRecordType - a cyclic time period search record type

Returns:

the cyclic time period search results record

Throws:

NullArgumentException - cyclicTimePeriodSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicTimePeriodSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.