Interface RegistrationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RegistrationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RegistrationQueryInspector	getRegistrationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RegistrationList	getRegistrations()	Gets the registration list resulting from a search.
RegistrationSearchResultsRecord	getRegistrationSearchResultsRecord(Type registrationSearchRecordType)	Gets the registration search results record corresponding to the given registration 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

getRegistrations

RegistrationList getRegistrations()

Gets the registration list resulting from a search.

Returns:

the registration list

Throws:

IllegalStateException - the registration list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getRegistrationQueryInspector

RegistrationQueryInspector getRegistrationQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getRegistrationSearchResultsRecord

RegistrationSearchResultsRecord getRegistrationSearchResultsRecord(Type registrationSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

registrationSearchRecordType - a registration search record type

Returns:

the registration search results record

Throws:

NullArgumentException - registrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.