org.osid.provisioning.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
void	clearAutomatic() Removes the automatic processing flag.
void	clearFifo() Removes the fifo flag.
void	clearRemovesProcessedQueueEntries() Removes the remove processed queue entries flag.
Metadata	getAutomaticMetadata() Gets the metadata for automatic processing.
Metadata	getFifoMetadata() Gets the metadata for first-in-first-out processing.
QueueProcessorFormRecord	getQueueProcessorFormRecord(Type queueProcessorRecordType) Gets the QueueProcessorFormRecord corresponding to the given queue processor record Type.
Metadata	getRemovesProcessedQueueEntriesMetadata() Gets the metadata for removal of procesed queue entries.
void	setAutomatic(boolean auto) Sets automatic processing.
void	setFifo(boolean fifo) Sets first-in-first-out processing
void	setRemovesProcessedQueueEntries(boolean remove) Sets removal of peocesse queue entry processing

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

getAutomaticMetadata

Metadata getAutomaticMetadata()

Gets the metadata for automatic processing.

Returns:

metadata for automatic processing

Compliance:

mandatory - This method must be implemented.

setAutomatic

void setAutomatic(boolean auto)

Sets automatic processing.

Parameters:

auto - true for automatic processing, false for manual processing

Throws:

InvalidArgumentException - auto is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAutomatic

void clearAutomatic()

Removes the automatic processing flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getFifoMetadata

Metadata getFifoMetadata()

Gets the metadata for first-in-first-out processing.

Returns:

metadata for fifo processing

Compliance:

mandatory - This method must be implemented.

setFifo

void setFifo(boolean fifo)

Sets first-in-first-out processing

Parameters:

fifo - true for fifo processing, false otherwise

Throws:

InvalidArgumentException - fifo is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearFifo

void clearFifo()

Removes the fifo flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRemovesProcessedQueueEntriesMetadata

Metadata getRemovesProcessedQueueEntriesMetadata()

Gets the metadata for removal of procesed queue entries.

Returns:

metadata for removing processed queue entry processing

Compliance:

mandatory - This method must be implemented.

setRemovesProcessedQueueEntries

void setRemovesProcessedQueueEntries(boolean remove)

Sets removal of peocesse queue entry processing

Parameters:

remove - true for removing processed queue entries, false otherwise

Throws:

InvalidArgumentException - remove is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRemovesProcessedQueueEntries

void clearRemovesProcessedQueueEntries()

Removes the remove processed queue entries flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

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.