Interface RegistrationRequestItemSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface RegistrationRequestItemSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
RegistrationRequestItemQueryInspector	getRegistrationRequestItemQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
RegistrationRequestItemList	getRegistrationRequestItems()	Gets the registration request item list resulting from a search.
RegistrationRequestItemSearchResultsRecord	getRegistrationRequestItemSearchResultsRecord(Type registrationRequestItemSearchRecordType)	Gets the registration request item search results record corresponding to the given registration request item 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

getRegistrationRequestItems

RegistrationRequestItemList getRegistrationRequestItems()

Gets the registration request item list resulting from a search.

Returns:

the registration request item list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestItemQueryInspector

RegistrationRequestItemQueryInspector getRegistrationRequestItemQueryInspector()

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

Returns:

the registration request item query inspector

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestItemSearchResultsRecord

RegistrationRequestItemSearchResultsRecord getRegistrationRequestItemSearchResultsRecord(Type registrationRequestItemSearchRecordType)
                                                                                  throws OperationFailedException

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

Parameters:

registrationRequestItemSearchRecordType - a registration request item search record type

Returns:

the registration request item search results record

Throws:

NullArgumentException - registrationRequestItemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestItemSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.