Interface ProvisionableEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProvisionableEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ProvisionableEnablerQueryInspector	getProvisionableEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ProvisionableEnablerList	getProvisionableEnablers()	Gets the provisionable enabler list resulting from a search.
ProvisionableEnablerSearchResultsRecord	getProvisionableEnablerSearchResultsRecord(Type provisionableEnablerSearchRecordType)	Gets the provisionable enabler search results record corresponding to the given provisionable 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

getProvisionableEnablers

ProvisionableEnablerList getProvisionableEnablers()

Gets the provisionable enabler list resulting from a search.

Returns:

the provisionable enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProvisionableEnablerQueryInspector

ProvisionableEnablerQueryInspector getProvisionableEnablerQueryInspector()

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

Returns:

the provisionable enabler query inspector

Compliance:

mandatory - This method must be implemented.

getProvisionableEnablerSearchResultsRecord

ProvisionableEnablerSearchResultsRecord getProvisionableEnablerSearchResultsRecord(Type provisionableEnablerSearchRecordType)
                                                                            throws OperationFailedException

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

Parameters:

provisionableEnablerSearchRecordType - a provisionable enabler search record type

Returns:

the provisionable enabler search results record

Throws:

NullArgumentException - provisionableEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.