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