org.osid.relationship

Interface FamilySearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface FamilySearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search and is used as a vehicle to perform a search within a previous result set.

Method Summary

Methods

Modifier and Type	Method and Description
FamilyList	getFamilies() Gets the family list resulting from a search.
FamilyQueryInspector	getFamilyQueryInspector() Gets the inspector for the query to examine the terms used in the search.
FamilySearchResultsRecord	getFamilySearchResultsRecord(Type familySearchRecordType) Gets the family search results record corresponding to the given family 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

getFamilies

FamilyList getFamilies()

Gets the family list resulting from a search.

Returns:

the family list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getFamilyQueryInspector

FamilyQueryInspector getFamilyQueryInspector()

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

Returns:

the family query inspector

Compliance:

mandatory - This method must be implemented.

getFamilySearchResultsRecord

FamilySearchResultsRecord getFamilySearchResultsRecord(Type familySearchRecordType)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

familySearchRecordType - a family search record type

Returns:

the family search results record

Throws:

NullArgumentException - FamilySearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(familySearchRecordType) is false

Compliance:

mandatory - This method must be implemented.