OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.FamilyForm
Implementsosid.OsidCatalogForm
Description

This is the form for creating and updating Family objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the FamilyAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetFamilyFormRecord
Description

Gets the FamilyFormRecord corresponding to the given family record Type.

Parametersosid.type.TypefamilyRecordTypethe family record type
Returnosid.relationship.records.FamilyFormRecordthe family form 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.