Interface ActivityRegistrationSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActivityRegistrationSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ActivityRegistrationQueryInspector	getActivityRegistrationQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ActivityRegistrationList	getActivityRegistrations()	Gets the activity registration list resulting from a search.
ActivityRegistrationSearchResultsRecord	getActivityRegistrationSearchResultsRecord(Type activityRegistrationSearchRecordType)	Gets the activity registration search results record corresponding to the given activity registration 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

getActivityRegistrations

ActivityRegistrationList getActivityRegistrations()

Gets the activity registration list resulting from a search.

Returns:

the activity registration list

Throws:

IllegalStateException - the activity registration list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationQueryInspector

ActivityRegistrationQueryInspector getActivityRegistrationQueryInspector()

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.

getActivityRegistrationSearchResultsRecord

ActivityRegistrationSearchResultsRecord getActivityRegistrationSearchResultsRecord(Type activityRegistrationSearchRecordType)
                                                                            throws OperationFailedException

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

Parameters:

activityRegistrationSearchRecordType - an activity registration search record type

Returns:

the activity registration search interface

Throws:

NullArgumentException - activityRegistrationSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityRegistrationSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.