public interface PoolProcessorForm extends OsidProcessorForm
This is the form for creating and updating PoolProcessors.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
PoolProcessorAdminSession.
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 |
clearAllocateByLeastCost()
Removes the allocate by least cost flag.
|
void |
clearAllocateByLeastUse()
Removes the allocate by least use flag.
|
void |
clearAllocateByMostCost()
Removes the allocate by most cost flag.
|
void |
clearAllocateByMostUse()
Removes the allocate by most use flag.
|
Metadata |
getAllocatesByLeastCostMetadata()
Gets the metadata for the allocates by least cost flag.
|
Metadata |
getAllocatesByLeastUseMetadata()
Gets the metadata for the allocates by least use flag.
|
Metadata |
getAllocatesByMostCostMetadata()
Gets the metadata for the allocates by most cost flag.
|
Metadata |
getAllocatesByMostUseMetadata()
Gets the metadata for the allocates by most use flag.
|
PoolProcessorFormRecord |
getPoolProcessorFormRecord(Type poolProcessorRecordType)
Gets the
PoolProcessorFormRecord corresponding to the
given pool processor record Type. |
void |
setAllocatesByLeastCost(boolean allocateByLeastCost)
Sets allocates by least cost flag.
|
void |
setAllocatesByLeastUse(boolean allocateByLeastUse)
Sets allocates by least use flag.
|
void |
setAllocatesByMostCost(boolean allocateByMostCost)
Sets allocates by most cost flag.
|
void |
setAllocatesByMostUse(boolean allocateByMostUse)
Sets allocates by most use flag.
|
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 getAllocatesByLeastUseMetadata()
mandatory
- This method must be implemented. void setAllocatesByLeastUse(boolean allocateByLeastUse)
allocateByLeastUse
- true
to allocate by least
use, false
otherwiseInvalidArgumentException
- allocateByLeastUse
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAllocateByLeastUse()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAllocatesByMostUseMetadata()
mandatory
- This method must be implemented. void setAllocatesByMostUse(boolean allocateByMostUse)
allocateByMostUse
- true
to allocate by most use,
false
otherwiseInvalidArgumentException
- allocateByMostUse
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAllocateByMostUse()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAllocatesByLeastCostMetadata()
mandatory
- This method must be implemented. void setAllocatesByLeastCost(boolean allocateByLeastCost)
allocateByLeastCost
- true
to allocate by least
cost, false
otherwiseInvalidArgumentException
- allocateByLeastCost
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAllocateByLeastCost()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAllocatesByMostCostMetadata()
mandatory
- This method must be implemented. void setAllocatesByMostCost(boolean allocateByMostCost)
allocateByMostCost
- true
to allocate by most
cost, false
otherwiseInvalidArgumentException
- allocateByMostCost
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAllocateByMostCost()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. PoolProcessorFormRecord getPoolProcessorFormRecord(Type poolProcessorRecordType) throws OperationFailedException
PoolProcessorFormRecord
corresponding to the
given pool processor record Type.
poolProcessorRecordType
- a pool processor record typeNullArgumentException
- poolProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolProcessorRecordType)
is false
mandatory
- This method must be implemented.