Interface AcknowledgementBatchProxyManager

All Superinterfaces:

AcknowledgementBatchProfile, AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface AcknowledgementBatchProxyManager
extends OsidProxyManager, AcknowledgementBatchProfile

The acknowledgement batch proxy manager provides access to acknowledgement batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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

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

Methods inherited from interface AcknowledgementBatchProfile

supportsBillingBatchAdmin, supportsCreditBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsBillingBatchAdmin()	Tests if bulk administration of billings is available.
boolean	supportsCreditBatchAdmin()	Tests if bulk administration of credits is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getCreditBatchAdminSession

CreditBatchAdminSession getCreditBatchAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the bulk credit administration service.

Parameters:

proxy - a proxy

Returns:

a CreditBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCreditBatchAdmin()} is {@code true} .

getCreditBatchAdminSessionForBilling

CreditBatchAdminSession getCreditBatchAdminSessionForBilling(Id billingId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

billingId - the Id of the Billing

proxy - a proxy

Returns:

a CreditBatchAdminSession

Throws:

NotFoundException - no Billing found by the given Id

NullArgumentException - billingId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCreditBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCreditBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getBillingBatchAdminSession

BillingBatchAdminSession getBillingBatchAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk billing administration service.

Parameters:

proxy - a proxy

Returns:

a BillingBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsBillingBatchAdmin()} is {@code true} .