OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.FamilySearchResults
Implementsosid.OsidSearchResults
Used Byosid.relationship.FamilySearchSession
Description

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.

MethodgetFamilies
Description

Gets the family list resulting from a search.

Returnosid.relationship.FamilyList the family list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetFamilyQueryInspector
Description

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

Returnosid.relationship.FamilyQueryInspector the family query inspector
Compliancemandatory This method must be implemented.
MethodgetFamilySearchResultsRecord
Description

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.

Parametersosid.type.TypefamilySearchRecordType a family search record type
Returnosid.relationship.records.FamilySearchResultsRecord the family search results record
ErrorsNULL_ARGUMENT FamilySearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(familySearchRecordType) is false
Compliancemandatory This method must be implemented.