OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountForm
Implementsosid.OsidObjectForm
osid.OsidFederateableForm
Description

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

MethodgetCreditBalanceMetadata
Description

Gets the metadata for the credit balance.

Returnosid.Metadatametadata for the credit balance
CompliancemandatoryThis method must be implemented.
MethodsetCreditBalance
Description

Sets the credit balance flag.

Parametersbooleancredit true if credits increase the balance, false if credits decrease the balance
ErrorsINVALID_ARGUMENT credit is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCreditBalance
Description

Removes the credit balance flag.

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

Gets the metadata for the code.

Returnosid.Metadatametadata for the code
CompliancemandatoryThis method must be implemented.
MethodsetCode
Description

Sets the code.

Parametersstringcodethe new code
ErrorsINVALID_ARGUMENT code is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT code is null
CompliancemandatoryThis method must be implemented.
MethodclearCode
Description

Removes the code.

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

Gets the AccountFormRecord corresponding to the given account record Type.

Parametersosid.type.TypeaccountRecordTypean account record type
Returnosid.financials.records.AccountFormRecordthe account form record
ErrorsNULL_ARGUMENT accountRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(accountRecordType) is false
CompliancemandatoryThis method must be implemented.