Interface ActionEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActionEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ActionEnablerQueryInspector	getActionEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ActionEnablerList	getActionEnablers()	Gets the ActionEnablerList resulting from a search.
ActionEnablerSearchResultsRecord	getActionEnablerSearchResultsRecord(Type actionEnablerSearchRecordType)	Gets the action enabler search results record corresponding to the given action 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

getActionEnablers

ActionEnablerList getActionEnablers()

Gets the ActionEnablerList resulting from a search.

Returns:

the action enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActionEnablerQueryInspector

ActionEnablerQueryInspector getActionEnablerQueryInspector()

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

Returns:

the action enabler query inspector

Compliance:

mandatory - This method must be implemented.

getActionEnablerSearchResultsRecord

ActionEnablerSearchResultsRecord getActionEnablerSearchResultsRecord(Type actionEnablerSearchRecordType)
                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerSearchRecordType - an action enabler search record type

Returns:

the action enabler search results record

Throws:

NullArgumentException - actionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(actionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.