org.osid.rules.check

Interface AgendaSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AgendaSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
AgendaQueryInspector	getAgendaQueryInspector() Gets the inspector for the query to examine the terms used in the search.
AgendaList	getAgendas() Gets the agenda list resulting from a search.
AgendaSearchResultsRecord	getAgendaSearchResultsRecord(Type agendaSearchRecordType) Gets the agenda search results record corresponding to the given agenda 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

getAgendas

AgendaList getAgendas()

Gets the agenda list resulting from a search.

Returns:

the agenda list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAgendaQueryInspector

AgendaQueryInspector getAgendaQueryInspector()

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

Returns:

the agenda query inspector

Compliance:

mandatory - This method must be implemented.

getAgendaSearchResultsRecord

AgendaSearchResultsRecord getAgendaSearchResultsRecord(Type agendaSearchRecordType)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

agendaSearchRecordType - an agenda search record type

Returns:

the agenda search results record

Throws:

NullArgumentException - agendaSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(agendaSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.