OSID Logo
OSID Specifications
acknowledgement batch package
Version 3.1.0
Interfaceosid.acknowledgement.batch.CreditBatchForm
Implementsosid.acknowledgement.CreditForm
Used Byosid.acknowledgement.batch.CreditBatchFormList
Description

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

Like all OsidForms, CreditBatchForm is stateful and must not be accessed by multiple processing threads.

MethodgetReferenceId
Description

Gets the reference Id of the credit if this is a create transaction.

Returnosid.id.Id the reference Id
ErrorsILLEGAL_STATE isForUpdate() is true
Compliancemandatory This method must be implemented.
MethodgetResourceId
Description

Gets the Resource Id of the credit if this is a create transaction.

Returnosid.id.Id the resource Id
ErrorsILLEGAL_STATE isForUpdate() is true
Compliancemandatory This method must be implemented.
MethodgetCreditId
Description

Gets the Id of the credit to be updated if this is an update transaction.

Returnosid.id.Id the credit Id
ErrorsILLEGAL_STATE isForUpdate() is false
Compliancemandatory This method must be implemented.