OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.Family
Implementsosid.OsidCatalog
Description

A Family represents a collection of relationships. Like all OSID objects, a Family is identified by its Id and any persisted references should use the Id.

MethodgetFamilyRecord
Description

Gets the famly record corresponding to the given Family record Type. This method is used to retrieve an object implementing the requested record. The familyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(familyRecordType) is true .

Parametersosid.type.TypefamilyRecordTypethe type of family record to retrieve
Returnosid.relationship.records.FamilyRecordthe family 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.