public interface ProvisionForm extends OsidRelationshipForm
This is the form for creating and updating Provisions.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
ProvisionAdminSession.
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 |
clearCost()
Removes the cost.
|
void |
clearDueDate()
Removes the due date.
|
void |
clearRateAmount()
Removes the rate amount.
|
void |
clearRatePeriod()
Removes the rate period.
|
void |
clearRequest()
Removes the request.
|
Metadata |
getCostMetadata()
Gets the metadata for the cost.
|
Metadata |
getDueDateMetadata()
Gets the metadata for the due date.
|
ProvisionFormRecord |
getProvisionFormRecord(Type provisionRecordType)
Gets the
ProvisionFormRecord corresponding to the given
provision record Type. |
Metadata |
getRateAmountMetadata()
Gets the metadata for the rate amount.
|
Metadata |
getRatePeriodMetadata()
Gets the metadata for the rate period.
|
Metadata |
getRequestMetadata()
Gets the metadata for the request.
|
void |
setCost(Currency cost)
Sets the cost.
|
void |
setDueDate(DateTime date)
Sets the due date.
|
void |
setRateAmount(Currency amount)
Sets the rate amount.
|
void |
setRatePeriod(Duration period)
Sets the rate period.
|
void |
setRequest(Id requestId)
Sets the request.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getRequestMetadata()
mandatory
- This method must be implemented. void setRequest(Id requestId)
requestId
- the new requestInvalidArgumentException
- requestId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- requestId
is
null
mandatory
- This method must be implemented. void clearRequest()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDueDateMetadata()
mandatory
- This method must be implemented. void setDueDate(DateTime date)
date
- the new due dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDueDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCostMetadata()
mandatory
- This method must be implemented. void setCost(Currency cost)
cost
- the new costInvalidArgumentException
- cost
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- cost
is
null
mandatory
- This method must be implemented. void clearCost()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRateAmountMetadata()
mandatory
- This method must be implemented. void setRateAmount(Currency amount)
amount
- the new rate amountInvalidArgumentException
- amount
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- amount
is
null
mandatory
- This method must be implemented. void clearRateAmount()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRatePeriodMetadata()
mandatory
- This method must be implemented. void setRatePeriod(Duration period)
period
- the new rate periodInvalidArgumentException
- period
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- period
is
null
mandatory
- This method must be implemented. void clearRatePeriod()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ProvisionFormRecord getProvisionFormRecord(Type provisionRecordType) throws OperationFailedException
ProvisionFormRecord
corresponding to the given
provision record Type.
provisionRecordType
- a provision record typeNullArgumentException
- provisionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionRecordType)
is false
mandatory
- This method must be implemented.