Interface ActivitySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActivitySearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ActivityList	getActivities()	Gets the activity list resulting from a search.
ActivityQueryInspector	getActivityQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ActivitySearchResultsRecord	getActivitySearchResultsRecord(Type activitySearchRecordType)	Gets the activity search results record corresponding to the given activity 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

getActivities

ActivityList getActivities()

Gets the activity list resulting from a search.

Returns:

the activity list

Throws:

IllegalStateException - the activity list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActivityQueryInspector

ActivityQueryInspector getActivityQueryInspector()

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.

getActivitySearchResultsRecord

ActivitySearchResultsRecord getActivitySearchResultsRecord(Type activitySearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

activitySearchRecordType - an activity search record type

Returns:

the activity search interface

Throws:

NullArgumentException - activitySearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activitySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.