OSID Specifications
relationship package
Version 3.1.0
relationship package
Version 3.1.0
| Interface | osid.relationship.FamilySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
| Used By | osid.relationship.FamilySearchSession | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getFamilySearchOrderRecord | ||
| Description |
Gets the family search record order corresponding to the given family record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | familyRecordType | a family record type |
| Return | osid.relationship.records.FamilySearchOrderRecord | the family search order record | |
| Errors | NULL_ARGUMENT | familyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(familyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |