OSID Logo
OSID Specifications
calendaring rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.rules.CommitmentEnabler
Implementsosid.OsidEnabler
Description

A CommitmentEnabler describes the rules for making Commitments effective.

MethodgetCommitmentEnablerRecord
Description

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

Parametersosid.type.TypecommitmentEnablerRecordTypethe type of commitment enabler record to retrieve
Returnosid.calendaring.rules.records.CommitmentEnablerRecordthe commitment enabler record
ErrorsNULL_ARGUMENT commitmentEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.