Interface ValueEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ValueEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ValueEnablerQueryInspector	getValueEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ValueEnablerList	getValueEnablers()	Gets the ValueEnablerList resulting from a search.
ValueEnablerSearchResultsRecord	getValueEnablerSearchResultsRecord(Type valueEnablerSearchRecordType)	Gets the value enabler search results record corresponding to the given value 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

getValueEnablers

ValueEnablerList getValueEnablers()

Gets the ValueEnablerList resulting from a search.

Returns:

the value enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getValueEnablerQueryInspector

ValueEnablerQueryInspector getValueEnablerQueryInspector()

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

Returns:

the value enabler query inspector

Compliance:

mandatory - This method must be implemented.

getValueEnablerSearchResultsRecord

ValueEnablerSearchResultsRecord getValueEnablerSearchResultsRecord(Type valueEnablerSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

valueEnablerSearchRecordType - a value enabler search record type

Returns:

the value enabler search results record

Throws:

NullArgumentException - valueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(valueEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.