org.osid.relationship

Interface FamilySearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FamilyQuerySession, OsidSession

public interface FamilySearchSession
extends FamilyQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
FamilySearchResults	getFamiliesBySearch(FamilyQuery familyQuery, FamilySearch familySearch) Gets the search results matching the given search.
FamilyQuery	getFamilyQueryFromInspector(FamilyQueryInspector familyQueryInspector) Gets a family query from an inspector.
FamilySearch	getFamilySearch() Gets a family search.
FamilySearchOrder	getFamilySearchOrder() Gets a family search order.

Methods inherited from interface org.osid.relationship.FamilyQuerySession

canSearchFamilies, getFamiliesByQuery, getFamilyQuery

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getFamilySearch

FamilySearch getFamilySearch()

Gets a family search.

Returns:

the family search

Compliance:

mandatory - This method must be implemented.

getFamilySearchOrder

FamilySearchOrder getFamilySearchOrder()

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

Returns:

the family search order

Compliance:

mandatory - This method must be implemented.

getFamiliesBySearch

FamilySearchResults getFamiliesBySearch(FamilyQuery familyQuery,
                                      FamilySearch familySearch)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets the search results matching the given search.

Parameters:

familyQuery - the family query

familySearch - the family search

Returns:

the search results

Throws:

NullArgumentException - familyQuery or familySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - familyQuery or familySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getFamilyQueryFromInspector

FamilyQuery getFamilyQueryFromInspector(FamilyQueryInspector familyQueryInspector)

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

Parameters:

familyQueryInspector - a family query inspector

Returns:

the familyh query

Throws:

NullArgumentException - familyQueryInspector is null

UnsupportedException - familyQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.