OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.FamilySearchSession
Implementsosid.relationship.FamilyQuerySession
Description

This session provides methods for searching Family objects. The search query is constructed using the FamilyQuery. The family record Type also specifies the record for the family query.

getFamiliesByQuery() is the basic search method and returns a list of Family elements. A more advanced search may be performed with getFamiliesBySearch(). It accepts a FamilySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getFamiliesBySearch() returns a FamilySearchResults that can be used to access the resulting FamilyList or be used to perform a search within the result set through FamilySearch.

Families may have a query record indicated by their respective record types. The query record is accessed via the FamilyQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetFamilySearch
Description

Gets a family search.

Returnosid.relationship.FamilySearchthe family search
CompliancemandatoryThis method must be implemented.
MethodgetFamilySearchOrder
Description

Gets a family search order. The FamilySearchOrder is supplied to a FamilySearch to specify the ordering of results.

Returnosid.relationship.FamilySearchOrderthe family search order
CompliancemandatoryThis method must be implemented.
MethodgetFamiliesBySearch
Description

Gets the search results matching the given search.

Parametersosid.relationship.FamilyQueryfamilyQuerythe family query
osid.relationship.FamilySearchfamilySearchthe family search
Returnosid.relationship.FamilySearchResultsthe search results
ErrorsNULL_ARGUMENT familyQuery or familySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED familyQuery or familySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFamilyQueryFromInspector
Description

Gets a family query from an inspector. The inspector is available from an FamilySearchResults.

Parametersosid.relationship.FamilyQueryInspectorfamilyQueryInspectora family query inspector
Returnosid.relationship.FamilyQuerythe familyh query
ErrorsNULL_ARGUMENT familyQueryInspector is null
UNSUPPORTED familyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.