org.osid.tracking

Interface Queue

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable

public interface Queue
extends OsidGovernator

A Queue governs the processing of Issues.

Method Summary

Methods

Modifier and Type	Method and Description
QueueRecord	getQueueRecord(Type queueRecordType) Gets the queue record corresponding to the given Queue record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getQueueRecord

QueueRecord getQueueRecord(Type queueRecordType)
                           throws OperationFailedException

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

Parameters:

queueRecordType - the type of queue record to retrieve

Returns:

the queue record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.