OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
relationship package
Version 3.0.0
Release Candidate Preview
| Interface | osid.relationship.FamilySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| 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. | ||
| Method | getFamilies | ||
| Description |
Gets the family list resulting from a search. | ||
| Return | osid.relationship.FamilyList | the family list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFamilyQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.relationship.FamilyQueryInspector | the family query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFamilySearchResultsRecord | ||
| 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. | ||
| Parameters | osid.type.Type | familySearchRecordType | a family search record type |
| Return | osid.relationship.records.FamilySearchResultsRecord | the family search results record | |
| Errors | NULL_ARGUMENT | FamilySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(familySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |