org.osid.repository

Interface CompositionSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CompositionSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
CompositionQueryInspector	getCompositionQueryInspector() Gets the inspector for the query to examine the terms used in the search.
CompositionList	getCompositions() Gets the composition list resulting from a search.
CompositionSearchResultsRecord	getCompositionSearchResultsRecord(Type compositionSearchRecordType) Gets the composition search results record corresponding to the given composition 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

getCompositions

CompositionList getCompositions()

Gets the composition list resulting from a search.

Returns:

the composition list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCompositionQueryInspector

CompositionQueryInspector getCompositionQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getCompositionSearchResultsRecord

CompositionSearchResultsRecord getCompositionSearchResultsRecord(Type compositionSearchRecordType)
                                                                 throws OperationFailedException

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

Parameters:

compositionSearchRecordType - a composition search record type

Returns:

the composition search results record

Throws:

NullArgumentException - compositionSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.