org.osid.relationship

Interface Family

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Family
extends OsidCatalog

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.

Method Summary

Methods

Modifier and Type	Method and Description
FamilyRecord	getFamilyRecord(Type familyRecordType) Gets the famly record corresponding to the given Family record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getFamilyRecord

FamilyRecord getFamilyRecord(Type familyRecordType)
                             throws OperationFailedException,
                                    PermissionDeniedException

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 .

Parameters:

familyRecordType - the type of family record to retrieve

Returns:

the family record

Throws:

NullArgumentException - familyRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(familyRecordType) is false

Compliance:

mandatory - This method must be implemented.