OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Interfaceosid.tracking.rules.QueueEnabler
Implementsosid.OsidEnabler
Used Byosid.tracking.rules.QueueEnablerAdminSession
osid.tracking.rules.QueueEnablerList
osid.tracking.rules.QueueEnablerLookupSession
Description

A QueueEnabler manages the active status of a Queue.

MethodgetQueueEnablerRecord
Description

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

Parametersosid.type.TypequeueEnablerRecordTypethe type of queue enabler record to retrieve
Returnosid.tracking.rules.records.QueueEnablerRecordthe queue enabler record
ErrorsNULL_ARGUMENTqueueEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(queueEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.