Interface QueueConstrainer

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule

public interface QueueConstrainer
extends OsidConstrainer

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

Like all OsidObjects, QueueConstrainer is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type	Method	Description
QueueConstrainerRecord	getQueueConstrainerRecord(Type queueConstrainerRecordType)	Gets the queue constrainer record corresponding to the given QueueConstrainer record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface Identifiable

getId, isCurrent

Methods inherited from interface Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface OsidRule

getConditionRecordTypes, getRule, getRuleId, hasRule

Method Details

getQueueConstrainerRecord

QueueConstrainerRecord getQueueConstrainerRecord(Type queueConstrainerRecordType)
                                          throws OperationFailedException

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.

Parameters:

queueConstrainerRecordType - the type of queue constrainer record to retrieve

Returns:

the queue constrainer record

Throws:

NullArgumentException - queueConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.