OSID Logo
OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.rules.RelationshipEnabler
Implementsosid.OsidEnabler
Description

A RelationshipEnabler describes the rules for making Relationships effective.

MethodgetRelationshipEnablerRecord
Description

Gets the relationship enabler record corresponding to the given RelationshipEnabler record Type. This method is used to retrieve an object implementing the requested record. The relationshipEnablerRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(relationshipEnablerRecordType) is true .

Parametersosid.type.TyperelationshipEnablerRecordTypethe type of relationship enabler record to retrieve
Returnosid.relationship.rules.records.RelationshipEnablerRecordthe relationship enabler record
ErrorsNULL_ARGUMENT relationshipEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(relationshipEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.