Interface ConvocationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ConvocationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ConvocationQueryInspector	getConvocationQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
ConvocationList	getConvocations()	Gets the convocation list resulting from a search.
ConvocationSearchResultsRecord	getConvocationSearchResultsRecord(Type convocationSearchRecordType)	Gets the convocation search results record corresponding to the given convocation 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

getConvocations

ConvocationList getConvocations()

Gets the convocation list resulting from a search.

Returns:

the convocation list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getConvocationQueryInspector

ConvocationQueryInspector getConvocationQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getConvocationSearchResultsRecord

ConvocationSearchResultsRecord getConvocationSearchResultsRecord(Type convocationSearchRecordType)
                                                          throws OperationFailedException

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

Parameters:

convocationSearchRecordType - a convocation search record type

Returns:

the convocation search record

Throws:

NullArgumentException - convocationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.