OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.Family
Implementsosid.OsidCatalog
Used Byosid.relationship.FamilyAdminSession
osid.relationship.FamilyList
osid.relationship.FamilyLookupSession
osid.relationship.FamilyNode
osid.relationship.RelationshipAdminSession
osid.relationship.RelationshipLookupSession
osid.relationship.RelationshipNotificationSession
osid.relationship.RelationshipQuerySession
osid.relationship.RelationshipSmartFamilySession
osid.relationship.rules.RelationshipEnablerAdminSession
show 6 more…
osid.relationship.rules.RelationshipEnablerLookupSession
osid.relationship.rules.RelationshipEnablerNotificationSession
osid.relationship.rules.RelationshipEnablerQuerySession
osid.relationship.rules.RelationshipEnablerRuleApplicationSession
osid.relationship.rules.RelationshipEnablerRuleLookupSession
osid.relationship.rules.RelationshipEnablerSmartFamilySession
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.TypefamilyRecordType the type of family record to retrieve
Returnosid.relationship.records.FamilyRecord the family record
ErrorsNULL_ARGUMENT familyRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(familyRecordType) is false
Compliancemandatory This method must be implemented.