org.osid.acknowledgement.batch

Interface AcknowledgementBatchManager

All Superinterfaces:

AcknowledgementBatchProfile, java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, Sourceable

public interface AcknowledgementBatchManager
extends OsidManager, AcknowledgementBatchProfile

The acknowledgement batch manager provides access to acknowledgement batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• CreditBatchSession: a session to create, modify and delete credits in bulk
• BillingBatchAdminSession: a session to create, modify and delete billings in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BillingBatchAdminSession	getBillingBatchAdminSession() Gets the OsidSession associated with the bulk billing administration service.
CreditBatchAdminSession	getCreditBatchAdminSession() Gets the OsidSession associated with the bulk credit administration service.
CreditBatchAdminSession	getCreditBatchAdminSessionForBilling(Id billingId) Gets the OsidSession associated with the bulk credit administration service for the given billing.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.acknowledgement.batch.AcknowledgementBatchProfile

supportsBillingBatchAdmin, supportsCreditBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCreditBatchAdminSession

CreditBatchAdminSession getCreditBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk credit administration service.

Returns:

a CreditBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCreditBatchAdmin() is true.

getCreditBatchAdminSessionForBilling

CreditBatchAdminSession getCreditBatchAdminSessionForBilling(Id billingId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk credit administration service for the given billing.

Parameters:

billingId - the Id of the Billing

Returns:

a CreditBatchAdminSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCreditBatchAdmin() and supportsVisibleFederation() are true

getBillingBatchAdminSession

BillingBatchAdminSession getBillingBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk billing administration service.

Returns:

a BillingBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsBillingBatchAdmin() is true.