org.osid.tracking.rules

Interface QueueConstrainerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidConstrainerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface QueueConstrainerForm
extends OsidConstrainerForm

This is the form for creating and updating QueueConstrainers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the QueueConstrainerAdminSession. 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
QueueConstrainerFormRecord	getQueueConstrainerFormRecord(Type queueConstrainerRecordType) Gets the QueueConstrainerFormRecord corresponding to the given queue constrainer record Type.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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

Method Detail

getQueueConstrainerFormRecord

QueueConstrainerFormRecord getQueueConstrainerFormRecord(Type queueConstrainerRecordType)
                                                         throws OperationFailedException

Gets the QueueConstrainerFormRecord corresponding to the given queue constrainer record Type.

Parameters:

queueConstrainerRecordType - a queue constrainer record type

Returns:

the queue constrainer form record

Throws:

NullArgumentException - queueConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.