Interface CanonicalUnitProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CanonicalUnitProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CanonicalUnitProcessorQueryInspector	getCanonicalUnitProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CanonicalUnitProcessorList	getCanonicalUnitProcessors()	Gets the CanonicalUnitProcessorList resulting from a search.
CanonicalUnitProcessorSearchResultsRecord	getCanonicalUnitProcessorSearchResultsRecord(Type canonicalUnitProcessorSearchRecordType)	Gets the canonical unit processor search results record corresponding to the given canonical unit processor 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

getCanonicalUnitProcessors

CanonicalUnitProcessorList getCanonicalUnitProcessors()

Gets the CanonicalUnitProcessorList resulting from a search.

Returns:

the canonical unit processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorQueryInspector

CanonicalUnitProcessorQueryInspector getCanonicalUnitProcessorQueryInspector()

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

Returns:

the canonical unit processor query inspector

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorSearchResultsRecord

CanonicalUnitProcessorSearchResultsRecord getCanonicalUnitProcessorSearchResultsRecord(Type canonicalUnitProcessorSearchRecordType)
                                                                                throws OperationFailedException,
PermissionDeniedException

Gets the canonical unit processor search results record corresponding to the given canonical unit processor search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

canonicalUnitProcessorSearchRecordType - a canonical unit processor search record type

Returns:

the canonical unit processor search results record

Throws:

NullArgumentException - canonicalUnitProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(canonicalUnitProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.