Interface ActivityUnitSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ActivityUnitSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ActivityUnitQueryInspector	getActivityUnitQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ActivityUnitList	getActivityUnits()	Gets the activity unit list resulting from a search.
ActivityUnitSearchResultsRecord	getActivityUnitSearchResultsRecord(Type activityUnitSearchRecordType)	Gets the activity unit search results record corresponding to the given activity unit 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

getActivityUnits

ActivityUnitList getActivityUnits()

Gets the activity unit list resulting from a search.

Returns:

the activity unit list

Throws:

IllegalStateException - the activity unit list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getActivityUnitQueryInspector

ActivityUnitQueryInspector getActivityUnitQueryInspector()

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.

getActivityUnitSearchResultsRecord

ActivityUnitSearchResultsRecord getActivityUnitSearchResultsRecord(Type activityUnitSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

activityUnitSearchRecordType - an activity unit search record type

Returns:

the activity unit search results record

Throws:

NullArgumentException - activityUnitSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(activityUnitSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.