Interface ProvisionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

ProvisionBatchForm

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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getRequestMetadata

Metadata getRequestMetadata()

Gets the metadata for the request.

Returns:

metadata for the request

Compliance:

mandatory - This method must be implemented.

setRequest

void setRequest(Id requestId)

Sets the request.

Parameters:

requestId - the new request

Throws:

InvalidArgumentException - requestId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - requestId is null

Compliance:

mandatory - This method must be implemented.

clearRequest

void clearRequest()

Removes the request.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDueDateMetadata

Metadata getDueDateMetadata()

Gets the metadata for the due date.

Returns:

metadata for the due date

Compliance:

mandatory - This method must be implemented.

setDueDate

void setDueDate(DateTime date)

Sets the due date.

Parameters:

date - the new due date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDueDate

void clearDueDate()

Removes the due date.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCostMetadata

Metadata getCostMetadata()

Gets the metadata for the cost.

Returns:

metadata for the cost amount

Compliance:

mandatory - This method must be implemented.

setCost

void setCost(Currency cost)

Sets the cost.

Parameters:

cost - the new cost

Throws:

InvalidArgumentException - cost is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - cost is null

Compliance:

mandatory - This method must be implemented.

clearCost

void clearCost()

Removes the cost.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRateAmountMetadata

Metadata getRateAmountMetadata()

Gets the metadata for the rate amount.

Returns:

metadata for the rate amount

Compliance:

mandatory - This method must be implemented.

setRateAmount

void setRateAmount(Currency amount)

Sets the rate amount.

Parameters:

amount - the new rate amount

Throws:

InvalidArgumentException - amount is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - amount is null

Compliance:

mandatory - This method must be implemented.

clearRateAmount

void clearRateAmount()

Removes the rate amount.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRatePeriodMetadata

Metadata getRatePeriodMetadata()

Gets the metadata for the rate period.

Returns:

metadata for the rate period

Compliance:

mandatory - This method must be implemented.

setRatePeriod

void setRatePeriod(Duration period)

Sets the rate period.

Parameters:

period - the new rate period

Throws:

InvalidArgumentException - period is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - period is null

Compliance:

mandatory - This method must be implemented.

clearRatePeriod

void clearRatePeriod()

Removes the rate period.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getProvisionFormRecord

ProvisionFormRecord getProvisionFormRecord(Type provisionRecordType)
                                    throws OperationFailedException

Gets the ProvisionFormRecord corresponding to the given provision record Type.

Parameters:

provisionRecordType - a provision record type

Returns:

the provision form record

Throws:

NullArgumentException - provisionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionRecordType) is false

Compliance:

mandatory - This method must be implemented.