OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.ItemForm
Implementsosid.OsidObjectForm
Description

This is the form for creating and updating Items. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ItemAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetCategoryMetadata
Description

Gets the metadata for the category.

Returnosid.Metadatametadata for the category
CompliancemandatoryThis method must be implemented.
MethodsetCategory
Description

Sets the category.

Parametersosid.id.IdcategoryIdthe new category
ErrorsINVALID_ARGUMENT categoryId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT categoryId is null
CompliancemandatoryThis method must be implemented.
MethodclearCategory
Description

Removes the category.

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

Gets the metadata for the general ledger account.

Returnosid.Metadatametadata for the account
CompliancemandatoryThis method must be implemented.
MethodsetAccount
Description

Sets the general ledger account.

Parametersosid.id.IdaccountIdthe new account
ErrorsINVALID_ARGUMENT accountId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT accountId is null
CompliancemandatoryThis method must be implemented.
MethodclearAccount
Description

Removes the account.

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

Gets the metadata for the product.

Returnosid.Metadatametadata for the product
CompliancemandatoryThis method must be implemented.
MethodsetProduct
Description

Sets the product.

Parametersosid.id.IdproductIdthe new product
ErrorsINVALID_ARGUMENT productId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT productId is null
CompliancemandatoryThis method must be implemented.
MethodclearProduct
Description

Removes the product.

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

Gets the metadata for the amount.

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

Sets the amount.

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

Removes the amount.

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

Gets the metadata for the debit flag.

Returnosid.Metadatametadata for the debit
CompliancemandatoryThis method must be implemented.
MethodsetDebit
Description

Sets the debit flag.

Parametersbooleandebit true for a debit, false for a credit
ErrorsINVALID_ARGUMENT debit is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearDebit
Description

Removes the debit flag.

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

Gets the metadata for the recurring interval.

Returnosid.Metadatametadata for the recurring interval
CompliancemandatoryThis method must be implemented.
MethodsetRecurringInterval
Description

Sets the recurring interval.

Parametersosid.calendaring.Durationintervalthe new interval
ErrorsINVALID_ARGUMENT interval is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT interval is null
CompliancemandatoryThis method must be implemented.
MethodclearRecurringInterval
Description

Removes the recurring interval and sets the item as a one-time charge.

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

Gets the ItemFormRecord corresponding to the given item record Type.

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.billing.records.ItemFormRecordthe item form record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.