OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.RelationshipForm
Implementsosid.OsidRelationshipForm
Description

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

MethodgetRelationshipFormRecord
Description

Gets the RelationshipFormRecord corresponding to the given relationship record Type.

Parametersosid.type.TyperelationshipRecordTypea relationship record type
Returnosid.relationship.records.RelationshipFormRecordthe relationship form record
ErrorsNULL_ARGUMENT relationshipRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(relationshipRecordType) is false
CompliancemandatoryThis method must be implemented.