OSID - osid.provisioning.ProvisionForm Service Interface Definition

Interface	osid.provisioning.ProvisionForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.provisioning.batch.ProvisionBatchForm`
Used By	`osid.provisioning.ProvisionAdminSession`
Description	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	getRequestMetadata
Description	Gets the metadata for the request.
Return	`osid.Metadata`		metadata for the request
Compliance	`mandatory`		This method must be implemented.
Method	setRequest
Description	Sets the request.
Parameters	`osid.id.Id`	`requestId`	the new request
Errors	INVALID_ARGUMENT		`requestId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`requestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequest
Description	Removes the request.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDueDateMetadata
Description	Gets the metadata for the due date.
Return	`osid.Metadata`		metadata for the due date
Compliance	`mandatory`		This method must be implemented.
Method	setDueDate
Description	Sets the due date.
Parameters	`osid.calendaring.DateTime`	`date`	the new due date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDueDate
Description	Removes the due date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCostMetadata
Description	Gets the metadata for the cost.
Return	`osid.Metadata`		metadata for the cost amount
Compliance	`mandatory`		This method must be implemented.
Method	setCost
Description	Sets the cost.
Parameters	`osid.financials.Currency`	`cost`	the new cost
Errors	INVALID_ARGUMENT		`cost` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`cost` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCost
Description	Removes the cost.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRateAmountMetadata
Description	Gets the metadata for the rate amount.
Return	`osid.Metadata`		metadata for the rate amount
Compliance	`mandatory`		This method must be implemented.
Method	setRateAmount
Description	Sets the rate amount.
Parameters	`osid.financials.Currency`	`amount`	the new rate amount
Errors	INVALID_ARGUMENT		`amount` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`amount` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRateAmount
Description	Removes the rate amount.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRatePeriodMetadata
Description	Gets the metadata for the rate period.
Return	`osid.Metadata`		metadata for the rate period
Compliance	`mandatory`		This method must be implemented.
Method	setRatePeriod
Description	Sets the rate period.
Parameters	`osid.calendaring.Duration`	`period`	the new rate period
Errors	INVALID_ARGUMENT		`period` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`period` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRatePeriod
Description	Removes the rate period.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProvisionFormRecord
Description	Gets the `ProvisionFormRecord` corresponding to the given provision record `Type`.
Parameters	`osid.type.Type`	`provisionRecordType`	a provision record type
Return	`osid.provisioning.records.ProvisionFormRecord`		the provision form record
Errors	NULL_ARGUMENT		`provisionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(provisionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.