public interface QueueForm extends OsidGovernatorForm, OsidSubjugateableForm
This is the form for creating and updating Queues.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the QueueAdminSession.
For each data element that may be set, metadata may be examined to
provide display hints or data constraints. Some data may be automatically
derived from the queue segments.
Modifier and Type | Method and Description |
---|---|
void |
clearCanSpecifyProvisionable()
Removes the can request provisionables flag.
|
Metadata |
getCanSpecifyProvisionableMetadata()
Gets the metadata for the can request provisionables flag.
|
QueueFormRecord |
getQueueFormRecord(Type queueRecordType)
Gets the
QueueFormRecord corresponding to the given
queue record Type. |
void |
setCanSpecifyProvisionable(long canRequest)
Sets the can request provisionables flag.
|
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
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
Metadata getCanSpecifyProvisionableMetadata()
mandatory
- This method must be implemented. void setCanSpecifyProvisionable(long canRequest)
canRequest
- the new can request provisionables flagInvalidArgumentException
- canRequest
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearCanSpecifyProvisionable()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. QueueFormRecord getQueueFormRecord(Type queueRecordType) throws OperationFailedException
QueueFormRecord
corresponding to the given
queue record Type.
queueRecordType
- a queue record typeNullArgumentException
- queueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueRecordType)
is false
mandatory
- This method must be implemented.