Interface | osid.relationship.FamilySearchSession | ||
---|---|---|---|
Implements | osid.relationship.FamilyQuerySession | ||
Description |
This session provides methods for searching Families may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getFamilySearch | ||
Description |
Gets a family search. | ||
Return | osid.relationship.FamilySearch | the family search | |
Compliance | mandatory | This method must be implemented. | |
Method | getFamilySearchOrder | ||
Description |
Gets a family search order. The | ||
Return | osid.relationship.FamilySearchOrder | the family search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getFamiliesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.relationship.FamilyQuery | familyQuery | the family query |
osid.relationship.FamilySearch | familySearch | the family search | |
Return | osid.relationship.FamilySearchResults | the search results | |
Errors | NULL_ARGUMENT | familyQuery or familySearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | familyQuery or familySearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFamilyQueryFromInspector | ||
Description |
Gets a family query from an inspector. The inspector is
available from an | ||
Parameters | osid.relationship.FamilyQueryInspector | familyQueryInspector | a family query inspector |
Return | osid.relationship.FamilyQuery | the familyh query | |
Errors | NULL_ARGUMENT | familyQueryInspector is null | |
UNSUPPORTED | familyQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |