org.osid.tracking.rules

Interface QueueProcessorForm

All Superinterfaces:

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

public interface QueueProcessorForm
extends OsidProcessorForm

This is the form for creating and updating QueueProcessors. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the QueueProcessorAdminSession. 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
QueueProcessorFormRecord	getQueueProcessorFormRecord(Type queueProcessorRecordType) Gets the QueueProcessorFormRecord corresponding to the given queue processor 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

getQueueProcessorFormRecord

QueueProcessorFormRecord getQueueProcessorFormRecord(Type queueProcessorRecordType)
                                                     throws OperationFailedException

Gets the QueueProcessorFormRecord corresponding to the given queue processor record Type.

Parameters:

queueProcessorRecordType - a queue processor record type

Returns:

the queue processor form record

Throws:

NullArgumentException - queueProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.