OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueConstrainer
Implementsosid.OsidConstrainer
Description

A QueueConstrainer describes the rules for constraining the tracking requests in a queue.

MethodgetQueueConstrainerRecord
Description

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

Parametersosid.type.TypequeueConstrainerRecordTypethe type of queue constrainer record to retrieve
Returnosid.tracking.rules.records.QueueConstrainerRecordthe queue constrainer record
ErrorsNULL_ARGUMENT queueConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.