Interface CanonicalUnitSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CanonicalUnitSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CanonicalUnitQueryInspector	getCanonicalUnitQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CanonicalUnitList	getCanonicalUnits()	Gets the canonical unit list resulting from a search.
CanonicalUnitSearchResultsRecord	getCanonicalUnitSearchResultsRecord(Type canonicalUnitSearchRecordType)	Gets the record corresponding to the given canonical unit search record Type.

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

getCanonicalUnits

CanonicalUnitList getCanonicalUnits()

Gets the canonical unit list resulting from a search.

Returns:

the canonical unit list

Throws:

IllegalStateException - the list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitQueryInspector

CanonicalUnitQueryInspector getCanonicalUnitQueryInspector()

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.

getCanonicalUnitSearchResultsRecord

CanonicalUnitSearchResultsRecord getCanonicalUnitSearchResultsRecord(Type canonicalUnitSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

canonicalUnitSearchRecordType - a canonical unit search record type

Returns:

the canonical unit search results record

Throws:

NullArgumentException - canonicalUnitSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(canonicalUnitSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.