Interface BillingBatchManager

All Superinterfaces:

AutoCloseable, BillingBatchProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface BillingBatchManager
extends OsidManager, BillingBatchProfile

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

• CustomerBatchAdminSession : a session to create, modify and delete customers in bulk
• ItemBatchSession : a session to create, modify and delete items in bulk
• EntryBatchAdminSession : a session to create, modify and delete entries in bulk
• CategoryBatchAdminSession : a session to create, modify and delete categories in bulk
• PeriodBatchAdminSession : a session to create, modify and delete periods in bulk
• BusinessBatchAdminSession : a session to create, modify and delete businesses in bulk

Method Summary

Modifier and Type	Method	Description
BusinessBatchAdminSession	getBusinessBatchAdminSession()	Gets the OsidSession associated with the bulk business administration service.
CategoryBatchAdminSession	getCategoryBatchAdminSession()	Gets the OsidSession associated with the bulk category administration service.
CategoryBatchAdminSession	getCategoryBatchAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the bulk category administration service for the given business.
CustomerBatchAdminSession	getCustomerBatchAdminSession()	Gets the OsidSession associated with the bulk customer administration service.
CustomerBatchAdminSession	getCustomerBatchAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the bulk customer administration service for the given business.
EntryBatchAdminSession	getEntryBatchAdminSession()	Gets the OsidSession associated with the bulk entry administration service.
EntryBatchAdminSession	getEntryBatchAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the bulk entry administration service for the given business.
ItemBatchAdminSession	getItemBatchAdminSession()	Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the bulk item administration service for the given business
PeriodBatchAdminSession	getPeriodBatchAdminSession()	Gets the OsidSession associated with the bulk period administration service.
PeriodBatchAdminSession	getPeriodBatchAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the bulk period administration service for the given business.

Methods inherited from interface BillingBatchProfile

supportsBusinessBatchAdmin, supportsCategoryBatchAdmin, supportsCustomerBatchAdmin, supportsEntryBatchAdmin, supportsItemBatchAdmin, supportsPeriodBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsBusinessBatchAdmin()	Tests if bulk administration of businesses is available.
boolean	supportsCategoryBatchAdmin()	Tests if bulk administration of categories is available.
boolean	supportsCustomerBatchAdmin()	Tests if bulk administration of customers is available.
boolean	supportsEntryBatchAdmin()	Tests if bulk administration of entries is available.
boolean	supportsItemBatchAdmin()	Tests if bulk administration of items is available.
boolean	supportsPeriodBatchAdmin()	Tests if bulk administration of periods is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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 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

getCustomerBatchAdminSession

CustomerBatchAdminSession getCustomerBatchAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk customer administration service.

Returns:

a CustomerBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBatchAdmin() is false

Compliance:

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

getCustomerBatchAdminSessionForBusiness

CustomerBatchAdminSession getCustomerBatchAdminSessionForBusiness(Id businessId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk customer administration service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a CustomerBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Returns:

an ItemBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

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

getItemBatchAdminSessionForBusiness

ItemBatchAdminSession getItemBatchAdminSessionForBusiness(Id businessId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk item administration service for the given business

Parameters:

businessId - the Id of the Business

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEntryBatchAdminSession

EntryBatchAdminSession getEntryBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk entry administration service.

Returns:

an EntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() is false

Compliance:

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

getEntryBatchAdminSessionForBusiness

EntryBatchAdminSession getEntryBatchAdminSessionForBusiness(Id businessId)
                                                     throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk entry administration service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

an EntryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCategoryBatchAdminSession

CategoryBatchAdminSession getCategoryBatchAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk category administration service.

Returns:

a CategoryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBatchAdmin() is false

Compliance:

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

getCategoryBatchAdminSessionForBusiness

CategoryBatchAdminSession getCategoryBatchAdminSessionForBusiness(Id businessId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk category administration service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a CategoryBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPeriodBatchAdminSession

PeriodBatchAdminSession getPeriodBatchAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the bulk period administration service.

Returns:

a PeriodBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodBatchAdmin() is false

Compliance:

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

getPeriodBatchAdminSessionForBusiness

PeriodBatchAdminSession getPeriodBatchAdminSessionForBusiness(Id businessId)
                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the bulk period administration service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a PeriodBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBusinessBatchAdminSession

BusinessBatchAdminSession getBusinessBatchAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk business administration service.

Returns:

a BusinessBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessBatchAdmin() is false

Compliance:

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