Interface TriggerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface TriggerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
TriggerEnablerQueryInspector	getTriggerEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
TriggerEnablerList	getTriggerEnablers()	Gets the TriggerEnablerList resulting from a search.
TriggerEnablerSearchResultsRecord	getTriggerEnablerSearchResultsRecord(Type triggerEnablerSearchRecordType)	Gets the trigger enabler search results record corresponding to the given trigger 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

getTriggerEnablers

TriggerEnablerList getTriggerEnablers()

Gets the TriggerEnablerList resulting from a search.

Returns:

the trigger enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerQueryInspector

TriggerEnablerQueryInspector getTriggerEnablerQueryInspector()

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

Returns:

the trigger enabler query inspector

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerSearchResultsRecord

TriggerEnablerSearchResultsRecord getTriggerEnablerSearchResultsRecord(Type triggerEnablerSearchRecordType)
                                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

triggerEnablerSearchRecordType - a trigger enabler search record type

Returns:

the trigger enabler search results record

Throws:

NullArgumentException - triggerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(triggerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.