Interface FinancialsBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, FinancialsBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface FinancialsBatchProxyManager
extends OsidProxyManager, FinancialsBatchProfile

The financials batch proxy manager provides access to financials 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:

• AccountBatchAdminSession : a session to create, modify and delete accounts in bulk
• ActivityBatchAdminSession : a session to create, modify and delete activities in bulk
• FiscalPeriodBatchAdminSession : a session to create, modify and delete fiscal periods in bulk
• BusinessBatchAdminSession : a session to create, modify and delete businesses in bulk

Method Summary

Modifier and Type	Method	Description
AccountBatchAdminSession	getAccountBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk account administration service.
AccountBatchAdminSession	getAccountBatchAdminSessionForBusiness(Id businessId, Proxy proxy)	Gets the OsidSession associated with the bulk account administration service for the given business.
ActivityBatchAdminSession	getActivityBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk activity administration service.
ActivityBatchAdminSession	getActivityBatchAdminSessionForBusiness(Id businessId, Proxy proxy)	Gets the OsidSession associated with the bulk activity administration service for the given business.
BusinessBatchAdminSession	getBusinessBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk business administration service.
FiscalPeriodBatchAdminSession	getFiscalPeriodBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk fiscal period administration service.
FiscalPeriodBatchAdminSession	getFiscalPeriodBatchAdminSessionForBusiness(Id businessId, Proxy proxy)	Gets the OsidSession associated with the bulk fiscal period administration service for the given business.

Methods inherited from interface Closeable

close

Methods inherited from interface FinancialsBatchProfile

supportsAccountBatchAdmin, supportsActivityBatchAdmin, supportsBusinessBatchAdmin, supportsFiscalPeriodBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAccountBatchAdmin()	Tests if bulk administration of accounts is available.
boolean	supportsActivityBatchAdmin()	Tests if bulk administration of activities is available.
boolean	supportsBusinessBatchAdmin()	Tests if bulk administration of businesses is available.
boolean	supportsFiscalPeriodBatchAdmin()	Tests if bulk administration of fiscal periods is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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

getAccountBatchAdminSession

AccountBatchAdminSession getAccountBatchAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk account administration service.

Parameters:

proxy - a proxy

Returns:

an AccountBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountBatchAdmin() is false

Compliance:

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

getAccountBatchAdminSessionForBusiness

AccountBatchAdminSession getAccountBatchAdminSessionForBusiness(Id businessId,
 Proxy proxy)
                                                         throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a AccountBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAccountBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getActivityBatchAdminSession

ActivityBatchAdminSession getActivityBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk activity administration service.

Parameters:

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() is false

Compliance:

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

getActivityBatchAdminSessionForBusiness

ActivityBatchAdminSession getActivityBatchAdminSessionForBusiness(Id businessId,
 Proxy proxy)
                                                           throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

an ActivityBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActivityBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getFiscalPeriodBatchAdminSession

FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the bulk fiscal period administration service.

Parameters:

proxy - a proxy

Returns:

a FiscalPeriodBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBatchAdmin() is false

Compliance:

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

getFiscalPeriodBatchAdminSessionForBusiness

FiscalPeriodBatchAdminSession getFiscalPeriodBatchAdminSessionForBusiness(Id businessId,
 Proxy proxy)
                                                                   throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - a proxy

Returns:

a FiscalPeriodBatchAdminSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFiscalPeriodBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBusinessBatchAdminSession

BusinessBatchAdminSession getBusinessBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk business administration service.

Parameters:

proxy - a proxy

Returns:

a BusinessBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessBatchAdmin() is false

Compliance:

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