Interface SupersedingEventEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SupersedingEventEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
SupersedingEventEnablerQueryInspector	getSupersedingEventEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
SupersedingEventEnablerList	getSupersedingEventEnablers()	Gets the SupersedingEventEnablerList resulting from a search.
SupersedingEventEnablerSearchResultsRecord	getSupersedingEventEnablerSearchResultsRecord(Type supersedingEventEnablerSearchRecordType)	Gets the superseding event enabler search results record corresponding to the given superseding event enabler search record Type.

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

getSupersedingEventEnablers

SupersedingEventEnablerList getSupersedingEventEnablers()

Gets the SupersedingEventEnablerList resulting from a search.

Returns:

the superseding event enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerQueryInspector

SupersedingEventEnablerQueryInspector getSupersedingEventEnablerQueryInspector()

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

Returns:

the superseding event enabler query inspector

Compliance:

mandatory - This method must be implemented.

getSupersedingEventEnablerSearchResultsRecord

SupersedingEventEnablerSearchResultsRecord getSupersedingEventEnablerSearchResultsRecord(Type supersedingEventEnablerSearchRecordType)
                                                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

supersedingEventEnablerSearchRecordType - a superseding event enabler search record type

Returns:

the superseding event enabler search results record

Throws:

NullArgumentException - supersedingEventEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(supersedingEventEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.