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.
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
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getAutomaticMetadata()
mandatory
- This method must be implemented. void setAutomatic(boolean auto)
auto
- true
for automatic processing,
false
for manual processingInvalidArgumentException
- auto
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAutomatic()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFifoMetadata()
mandatory
- This method must be implemented. void setFifo(boolean fifo)
fifo
- true
for fifo processing, false
otherwiseInvalidArgumentException
- fifo
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearFifo()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRemovesProcessedQueueEntriesMetadata()
mandatory
- This method must be implemented. void setRemovesProcessedQueueEntries(boolean remove)
remove
- true
for removing processed queue
entries, false
otherwiseInvalidArgumentException
- remove
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRemovesProcessedQueueEntries()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. QueueProcessorFormRecord getQueueProcessorFormRecord(Type queueProcessorRecordType) throws OperationFailedException
QueueProcessorFormRecord
corresponding to the
given queue processor record Type.
queueProcessorRecordType
- a queue processor record typeNullArgumentException
- queueProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueProcessorRecordType)
is
false
mandatory
- This method must be implemented.