Interface TriggerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TriggerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
TriggerQueryInspector	getTriggerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
TriggerList	getTriggers()	Gets the trigger list resulting from a search.
TriggerSearchResultsRecord	getTriggerSearchResultsRecord(Type triggerSearchRecordType)	Gets the trigger search results record corresponding to the given trigger 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

getTriggers

TriggerList getTriggers()

Gets the trigger list resulting from a search.

Returns:

the trigger list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getTriggerQueryInspector

TriggerQueryInspector getTriggerQueryInspector()

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

Returns:

the trigger query inspector

Compliance:

mandatory - This method must be implemented.

getTriggerSearchResultsRecord

TriggerSearchResultsRecord getTriggerSearchResultsRecord(Type triggerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

triggerSearchRecordType - a trigger search record type

Returns:

the trigger search results record

Throws:

NullArgumentException - triggerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(triggerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.