public interface PoolForm extends OsidGovernatorForm, OsidSubjugateableForm
This is the form for creating and updating Pools.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the PoolAdminSession.
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 |
---|---|
PoolFormRecord |
getPoolFormRecord(Type poolRecordType)
Gets the
PoolFormRecord corresponding to the given pool
record Type. |
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
PoolFormRecord getPoolFormRecord(Type poolRecordType) throws OperationFailedException
PoolFormRecord
corresponding to the given pool
record Type.
poolRecordType
- a pool record typeNullArgumentException
- poolRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(poolRecordType)
is false
mandatory
- This method must be implemented.