Interface CanonicalUnitEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CanonicalUnitEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CanonicalUnitEnablerQueryInspector	getCanonicalUnitEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CanonicalUnitEnablerList	getCanonicalUnitEnablers()	Gets the CanonicalUnitEnablerList resulting from a search.
CanonicalUnitEnablerSearchResultsRecord	getCanonicalUnitEnablerSearchResultsRecord(Type canonicalUnitEnablerSearchRecordType)	Gets the canonical unit enabler search results record corresponding to the given canonical unit enabler 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

getCanonicalUnitEnablers

CanonicalUnitEnablerList getCanonicalUnitEnablers()

Gets the CanonicalUnitEnablerList resulting from a search.

Returns:

the canonical unit enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerQueryInspector

CanonicalUnitEnablerQueryInspector getCanonicalUnitEnablerQueryInspector()

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

Returns:

the canonical unit enabler query inspector

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablerSearchResultsRecord

CanonicalUnitEnablerSearchResultsRecord getCanonicalUnitEnablerSearchResultsRecord(Type canonicalUnitEnablerSearchRecordType)
                                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerSearchRecordType - a canonical unit enabler search record type

Returns:

the canonical unit enabler search results record

Throws:

NullArgumentException - canonicalUnitEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(canonicalUnitEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.