OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.FamilySearchOrder
Implementsosid.OsidCatalogSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetFamilySearchOrderRecord
Description

Gets the family search record order corresponding to the given family record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypefamilyRecordTypea family record type
Returnosid.relationship.records.FamilySearchOrderRecordthe family search order record
ErrorsNULL_ARGUMENT familyRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(familyRecordType) is false
CompliancemandatoryThis method must be implemented.