org.osid.tracking

Interface QueueForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

QueueBatchForm

public interface QueueForm
extends OsidGovernatorForm

This is the form for creating and updating Queues. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the QueueAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
QueueFormRecord	getQueueFormRecord(Type queueRecordType) Gets the QueueFormRecord corresponding to the given queue record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getQueueFormRecord

QueueFormRecord getQueueFormRecord(Type queueRecordType)
                                   throws OperationFailedException

Gets the QueueFormRecord corresponding to the given queue record Type.

Parameters:

queueRecordType - a queue record type

Returns:

the queue form record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.