OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.ProvisionForm
Implementsosid.OsidRelationshipForm
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.

MethodgetRequestMetadata
Description

Gets the metadata for the request.

Returnosid.Metadatametadata for the request
CompliancemandatoryThis method must be implemented.
MethodsetRequest
Description

Sets the request.

Parametersosid.id.IdrequestIdthe new request
ErrorsINVALID_ARGUMENT requestId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT requestId is null
CompliancemandatoryThis method must be implemented.
MethodclearRequest
Description

Removes the request.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDueDateMetadata
Description

Gets the metadata for the due date.

Returnosid.Metadatametadata for the due date
CompliancemandatoryThis method must be implemented.
MethodsetDueDate
Description

Sets the due date.

Parametersosid.calendaring.DateTimedatethe new due date
ErrorsINVALID_ARGUMENT date is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodclearDueDate
Description

Removes the due date.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCostMetadata
Description

Gets the metadata for the cost.

Returnosid.Metadatametadata for the cost amount
CompliancemandatoryThis method must be implemented.
MethodsetCost
Description

Sets the cost.

Parametersosid.financials.Currencycostthe new cost
ErrorsINVALID_ARGUMENT cost is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT cost is null
CompliancemandatoryThis method must be implemented.
MethodclearCost
Description

Removes the cost.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRateAmountMetadata
Description

Gets the metadata for the rate amount.

Returnosid.Metadatametadata for the rate amount
CompliancemandatoryThis method must be implemented.
MethodsetRateAmount
Description

Sets the rate amount.

Parametersosid.financials.Currencyamountthe new rate amount
ErrorsINVALID_ARGUMENT amount is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT amount is null
CompliancemandatoryThis method must be implemented.
MethodclearRateAmount
Description

Removes the rate amount.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetRatePeriodMetadata
Description

Gets the metadata for the rate period.

Returnosid.Metadatametadata for the rate period
CompliancemandatoryThis method must be implemented.
MethodsetRatePeriod
Description

Sets the rate period.

Parametersosid.calendaring.Durationperiodthe new rate period
ErrorsINVALID_ARGUMENT period is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT period is null
CompliancemandatoryThis method must be implemented.
MethodclearRatePeriod
Description

Removes the rate period.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetProvisionFormRecord
Description

Gets the ProvisionFormRecord corresponding to the given provision record Type.

Parametersosid.type.TypeprovisionRecordTypea provision record type
Returnosid.provisioning.records.ProvisionFormRecordthe provision form record
ErrorsNULL_ARGUMENT provisionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionRecordType) is false
CompliancemandatoryThis method must be implemented.