Interface CatalogEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface CatalogEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
CatalogEnablerQueryInspector	getCatalogEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
CatalogEnablerList	getCatalogEnablers()	Gets the CatalogEnablerList resulting from a search.
CatalogEnablerSearchResultsRecord	getCatalogEnablerSearchResultsRecord(Type catalogEnablerSearchRecordType)	Gets the catalog enabler search results record corresponding to the given catalog enabler search record Type .This method must be 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

getCatalogEnablers

CatalogEnablerList getCatalogEnablers()

Gets the CatalogEnablerList resulting from a search.

Returns:

the catalog enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerQueryInspector

CatalogEnablerQueryInspector getCatalogEnablerQueryInspector()

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

Returns:

the catalog enabler query inspector

Compliance:

mandatory - This method must be implemented.

getCatalogEnablerSearchResultsRecord

CatalogEnablerSearchResultsRecord getCatalogEnablerSearchResultsRecord(Type catalogEnablerSearchRecordType)
                                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

catalogEnablerSearchRecordType - a catalog enabler search record type

Returns:

the catalog enabler search results record

Throws:

NullArgumentException - catalogEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(catalogEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.