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

An OffsetEventEnabler describes the rules for making an OffsetEvent effective.

MethodgetOffsetEventEnablerRecord
Description

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

Parametersosid.type.TypeoffsetEventEnablerRecordTypethe type of offset event enabler record to retrieve
Returnosid.calendaring.rules.records.OffsetEventEnablerRecordthe offset event enabler record
ErrorsNULL_ARGUMENT offsetEventEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offsetEventEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.