org.osid.profile

Interface ProfileItemSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ProfileItemSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ProfileItemQueryInspector	getProfileItemQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ProfileItemList	getProfileItems() Gets the profile item list resulting from the search.
ProfileItemSearchResultsRecord	getProfileItemSearchResultsRecord(Type profileItemSearchRecordType) Gets the profile search results record corresponding to the given profile item search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getProfileItems

ProfileItemList getProfileItems()

Gets the profile item list resulting from the search.

Returns:

the profile item list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getProfileItemQueryInspector

ProfileItemQueryInspector getProfileItemQueryInspector()

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

Returns:

the profile item query inspector

Compliance:

mandatory - This method must be implemented.

getProfileItemSearchResultsRecord

ProfileItemSearchResultsRecord getProfileItemSearchResultsRecord(Type profileItemSearchRecordType)
                                                                 throws OperationFailedException

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

Parameters:

profileItemSearchRecordType - a profile item search record type

Returns:

the profile item search results record

Throws:

NullArgumentException - profileItemSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileItemSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.