OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Interfaceosid.subscription.rules.DispatchEnabler
Implementsosid.OsidEnabler
Used Byosid.subscription.rules.DispatchEnablerAdminSession
osid.subscription.rules.DispatchEnablerList
osid.subscription.rules.DispatchEnablerLookupSession
Description

A DispatchEnabler manages the active status of a Dispatch.

MethodgetDispatchEnablerRecord
Description

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

Parametersosid.type.TypedispatchEnablerRecordTypethe type of dispatch enabler record to retrieve
Returnosid.subscription.rules.records.DispatchEnablerRecordthe dispatch enabler record
ErrorsNULL_ARGUMENTdispatchEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(dispatchEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.