Interface ActionGroupSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActionGroupSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ActionGroupQueryInspector	getActionGroupQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ActionGroupList	getActionGroups()	Gets the action group list resulting from a search.
ActionGroupSearchResultsRecord	getActionGroupSearchResultsRecord(Type actionGroupSearchRecordType)	Gets the action group search results record corresponding to the given action group search record Type .This method is 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

getActionGroups

ActionGroupList getActionGroups()

Gets the action group list resulting from a search.

Returns:

the action group list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getActionGroupQueryInspector

ActionGroupQueryInspector getActionGroupQueryInspector()

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

Returns:

the action group query inspector

Compliance:

mandatory - This method must be implemented.

getActionGroupSearchResultsRecord

ActionGroupSearchResultsRecord getActionGroupSearchResultsRecord(Type actionGroupSearchRecordType)
                                                          throws OperationFailedException

Gets the action group search results record corresponding to the given action group search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

actionGroupSearchRecordType - an action group search record type

Returns:

the action group search results record

Throws:

NullArgumentException - actionGroupSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionGroupSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.