org.osid.provisioning.rules

Interface QueueProcessorEnablerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidTemporalForm, Suppliable

public interface QueueProcessorEnablerForm
extends OsidEnablerForm

This is the form for creating and updating QueueProcessorEnablers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the QueueProcessorEnablerAdminSession. 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
QueueProcessorEnablerFormRecord	getQueueProcessorEnablerFormRecord(Type queueProcessorEnablerRecordType) Gets the QueueProcessorEnablerFormRecord corresponding to the given queue processor enabler record Type.

Methods inherited from interface org.osid.OsidEnablerForm

clearCyclicEvent, clearDemographic, clearEvent, clearSchedule, getCyclicEventMetadata, getDemographicMetadata, getEventMetadata, getScheduleMetadata, setCyclicEvent, setDemographic, setEvent, setSchedule

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getQueueProcessorEnablerFormRecord

QueueProcessorEnablerFormRecord getQueueProcessorEnablerFormRecord(Type queueProcessorEnablerRecordType)
                                                                   throws OperationFailedException

Gets the QueueProcessorEnablerFormRecord corresponding to the given queue processor enabler record Type.

Parameters:

queueProcessorEnablerRecordType - a queue processor enabler record type

Returns:

the queue processor enabler form record

Throws:

NullArgumentException - queueProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.