OSID Logo
OSID Specifications
relationship package
Version 3.1.0
Interfaceosid.relationship.FamilyForm
Implementsosid.OsidCatalogForm
Implemented Byosid.relationship.batch.FamilyBatchForm
Used Byosid.relationship.FamilyAdminSession
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.TypefamilyRecordType the family record type
Returnosid.relationship.records.FamilyFormRecord the family form 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.