public interface QueueConstrainerForm extends OsidConstrainerForm
This is the form for creating and updating QueueConstrainers.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
QueueConstrainerAdminSession.
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 |
clearRequiredProvisionPools()
Clears the required provision pools.
|
void |
clearRequiresProvisions()
Removes the requires provisions flag.
|
void |
clearSizeLimit()
Removes the size limit.
|
QueueConstrainerFormRecord |
getQueueConstrainerFormRecord(Type queueConstrainerRecordType)
Gets the
QueueConstrainerFormRecord corresponding to
the given queue constrainer record Type. |
Metadata |
getRequiredProvisionPoolsMetadata()
Gets the metadata for the required pools.
|
Metadata |
getRequiresProvisionsMetadata()
Gets the metadata for the requires provisions flag.
|
Metadata |
getSizeLimitMetadata()
Gets the metadata for the size limit.
|
void |
setRequiredProvisionPools(Id[] poolIds)
Sets the required provision pools.
|
void |
setRequiresProvisions(long requiresProvisions)
Sets the requires provisions flag.
|
void |
setSizeLimit(long limit)
Sets the size limit.
|
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 getSizeLimitMetadata()
mandatory
- This method must be implemented. void setSizeLimit(long limit)
limit
- the new limitInvalidArgumentException
- limit
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearSizeLimit()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRequiresProvisionsMetadata()
mandatory
- This method must be implemented. void setRequiresProvisions(long requiresProvisions)
requiresProvisions
- the new requires provisionsInvalidArgumentException
- requiresProvisions
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRequiresProvisions()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRequiredProvisionPoolsMetadata()
mandatory
- This method must be implemented. void setRequiredProvisionPools(Id[] poolIds)
poolIds
- the new poolsInvalidArgumentException
- poolIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- poolIds
is
null
mandatory
- This method must be implemented. void clearRequiredProvisionPools()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. QueueConstrainerFormRecord getQueueConstrainerFormRecord(Type queueConstrainerRecordType) throws OperationFailedException
QueueConstrainerFormRecord
corresponding to
the given queue constrainer record Type.
queueConstrainerRecordType
- a queue constrainer record typeNullArgumentException
-
queueConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(queueConstrainerRecordType)
is
false
mandatory
- This method must be implemented.