public interface BrokerProcessorForm extends OsidProcessorForm
This is the form for creating and updating BrokerProcessors.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
BrokerProcessorAdminSession.
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 |
clearAllowsCompoundRequests()
Removes the allows compound requests flag.
|
void |
clearAllowsProvisionExchange()
Removes the allows provision exchange flag.
|
void |
clearFixedLeaseDuration()
Removes the fixed lease duration.
|
void |
clearLeasing()
Removes the fixed lease flag.
|
void |
clearMustReturnProvisions()
Removes the must return provisions flag.
|
Metadata |
getAllowsCompoundRequestsMetadata()
Gets the metadata for the allows provision exchange flag.
|
Metadata |
getAllowsProvisionExchangeMetadata()
Gets the metadata for the allows provision exchange flag.
|
BrokerProcessorFormRecord |
getBrokerProcessorFormRecord(Type brokerProcessorRecordType)
Gets the
BrokerProcessorFormRecord corresponding to the
given broker processor record Type. |
Metadata |
getFixedLeaseDurationMetadata()
Gets the metadata for the fixed lease duration.
|
Metadata |
getLeasingMetadata()
Gets the metadata for the leasing flag.
|
Metadata |
getMustReturnProvisionsMetadata()
Gets the metadata for the must return provisions flag.
|
void |
setAllowsCompoundRequests(boolean allowsCompound)
Sets the allows compound requests flag.
|
void |
setAllowsProvisionExchange(boolean allowsExchange)
Sets the allows provision exchange flag.
|
void |
setFixedLeaseDuration(boolean duration)
Sets the fixed lease duration.
|
void |
setLeasing(boolean leasing)
Sets the leasing flag.
|
void |
setMustReturnProvisions(boolean mustReturn)
Sets the must return provisions 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 getLeasingMetadata()
mandatory
- This method must be implemented. void setLeasing(boolean leasing)
leasing
- the new leasing flagInvalidArgumentException
- leasing
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearLeasing()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFixedLeaseDurationMetadata()
mandatory
- This method must be implemented. void setFixedLeaseDuration(boolean duration)
duration
- the new fixed lease duration.InvalidArgumentException
- duration
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearFixedLeaseDuration()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMustReturnProvisionsMetadata()
mandatory
- This method must be implemented. void setMustReturnProvisions(boolean mustReturn)
mustReturn
- the new must return provisions flagInvalidArgumentException
- mustReturn
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMustReturnProvisions()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAllowsProvisionExchangeMetadata()
mandatory
- This method must be implemented. void setAllowsProvisionExchange(boolean allowsExchange)
allowsExchange
- the new allows provision exchange flagInvalidArgumentException
- allowsExchange
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAllowsProvisionExchange()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAllowsCompoundRequestsMetadata()
mandatory
- This method must be implemented. void setAllowsCompoundRequests(boolean allowsCompound)
allowsCompound
- the new allows compound requests flagInvalidArgumentException
- allowsExchange
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAllowsCompoundRequests()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. BrokerProcessorFormRecord getBrokerProcessorFormRecord(Type brokerProcessorRecordType) throws OperationFailedException
BrokerProcessorFormRecord
corresponding to the
given broker processor record Type.
brokerProcessorRecordType
- a broker processor record typeNullArgumentException
-
brokerProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(brokerProcessorRecordType)
is
false
mandatory
- This method must be implemented.