Interface ProvisionEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProvisionEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProvisionEnablerQueryInspector	getProvisionEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProvisionEnablerList	getProvisionEnablers()	Gets the provision enabler list resulting from a search.
ProvisionEnablerSearchResultsRecord	getProvisionEnablerSearchResultsRecord(Type provisionEnablerSearchRecordType)	Gets the provision enabler search results record corresponding to the given provision 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

getProvisionEnablers

ProvisionEnablerList getProvisionEnablers()

Gets the provision enabler list resulting from a search.

Returns:

the provision enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProvisionEnablerQueryInspector

ProvisionEnablerQueryInspector getProvisionEnablerQueryInspector()

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

Returns:

the provision enabler query inspector

Compliance:

mandatory - This method must be implemented.

getProvisionEnablerSearchResultsRecord

ProvisionEnablerSearchResultsRecord getProvisionEnablerSearchResultsRecord(Type provisionEnablerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

provisionEnablerSearchRecordType - a provision enabler search record type

Returns:

the provision enabler search results record

Throws:

NullArgumentException - provisionEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.