Interface BillingManager

All Superinterfaces:

AutoCloseable, BillingProfile, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable

public interface BillingManager
extends OsidManager, BillingProfile

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

• CustomerLookupSession : a session to retrieve customers
• CustomerQuerySession : a session to query customers
• CustomerSearchSession : a session to search for customers
• CustomerAdminSession : a session to create and delete customers
• CustomerNotificationSession : a session to receive notifications pertaining to customer changes
• CustomerBusinessSession : a session to look up customer to business mappings
• CustomerBusinessAssignmentSession : a session to manage customer to business mappings
• CustomerSmartBusinessSession : a session to manage dynamic businesses of customers

• ItemLookupSession : a session to retrieve items
• ItemQuerySession : a session to query items
• ItemSearchSession : a session to search for items
• ItemAdminSession : a session to create and delete items
• ItemNotificationSession : a session to receive notifications pertaining to item changes
• ItemBusinessSession : a session to look up item to business mappings
• ItemBusinessAssignmentSession : a session to manage item to business mappings
• ItemSmartBusinessSession : a session to manage dynamic businesses of items

• CategoryLookupSession : a session to retrieve categories
• CategoryQuerySession : a session to query categories
• CategorySearchSession : a session to search for categories
• CategoryAdminSession : a session to create and delete categories
• CategoryNotificationSession : a session to receive notifications pertaining to category changes
• CategoryBusinessSession : a session to look up category to business mappings
• CategoryBusinessAssignmentSession : a session to manage category to business mappings
• CategorySmartBusinessSession : a session to manage dynamic businesses of categories

• EntryLookupSession : a session to retrieve entries
• EntryLookupSession : a session to query entries
• EntrySearchSession : a session to search for entries
• EntryAdminSession : a session to create and delete entries
• EntryNotificationSession : a session to receive notifications pertaining to entry changes
• EntryBusinessSession : a session to look up entry to business mappings
• EntryBusinessAssignmentSession : a session to manage entry to business mappings
• EntrySmartBusinessAssignmentSession : a session to manage dynamic businesses of entries

• PeriodLookupSession : a session to retrieve periods
• PeriodLookupSession : a session to query periods
• PeriodSearchSession : a session to search for periods
• PeriodAdminSession : a session to create and delete periods
• PeriodNotificationSession : a session to receive notifications pertaining to period changes
• PeriodBusinessSession : a session to look up period to business mappings
• PeriodBusinessAssignmentSession : a session to manage period to business mappings
• PeriodSmartBusinessAssignmentSession : a session to manage dynamic businesses of periods

• BusinessLookupSession : a session to retrieve businesses
• BusinessQuerySession : a session to query businesses
• BusinessSearchSession : a session to search for businesses
• BusinessAdminSession : a session to create and delete businesses
• BusinessNotificationSession : a session to receive notifications pertaining to business changes
• BusinessHierarchySession : a session to traverse a hierarchy of businesses
• BusinessHierarchyDesignSession : a session to manage a business hierarchy

Method Summary

Modifier and Type	Method	Description
BillingBatchManager	getBillingBatchManager()	Gets a BillingBatchManager .
BillingPaymentManager	getBillingPaymentManager()	Gets a BillingPaymentManager .
BusinessAdminSession	getBusinessAdminSession()	Gets the OsidSession associated with the business administrative service.
BusinessHierarchyDesignSession	getBusinessHierarchyDesignSession()	Gets the OsidSession associated with the business hierarchy design service.
BusinessHierarchySession	getBusinessHierarchySession()	Gets the OsidSession associated with the business hierarchy service.
BusinessLookupSession	getBusinessLookupSession()	Gets the OsidSession associated with the business lookup service.
BusinessNotificationSession	getBusinessNotificationSession(BusinessReceiver businessReceiver)	Gets the OsidSession associated with the business notification service.
BusinessQuerySession	getBusinessQuerySession()	Gets the OsidSession associated with the business query service.
BusinessSearchSession	getBusinessSearchSession()	Gets the OsidSession associated with the business search service.
CategoryAdminSession	getCategoryAdminSession()	Gets the OsidSession associated with the category administration service.
CategoryAdminSession	getCategoryAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the category administration service for the given business.
CategoryBusinessAssignmentSession	getCategoryBusinessAssignmentSession()	Gets the OsidSession associated with assigning categories to businesses.
CategoryBusinessSession	getCategoryBusinessSession()	Gets the OsidSession to lookup category/catalog mappings.
CategoryLookupSession	getCategoryLookupSession()	Gets the OsidSession associated with the category lookup service.
CategoryLookupSession	getCategoryLookupSessionForBusiness(Id businessId)	Gets the OsidSession associated with the category lookup service for the given business.
CategoryNotificationSession	getCategoryNotificationSession(CategoryReceiver categoryReceiver)	Gets the OsidSession associated with the category notification service.
CategoryNotificationSession	getCategoryNotificationSessionForBusiness(CategoryReceiver categoryReceiver, Id businessId)	Gets the OsidSession associated with the category notification service for the given business.
CustomerQuerySession	getCategoryQuerySession()	Gets the OsidSession associated with the category query service.
CustomerQuerySession	getCategoryQuerySessionForBusiness(Id businessId)	Gets the OsidSession associated with the category query service for the given business.
CategorySearchSession	getCategorySearchSession()	Gets the OsidSession associated with the category search service.
CategorySearchSession	getCategorySearchSessionForBusiness(Id businessId)	Gets the OsidSession associated with the category search service for the given business.
CategorySmartBusinessSession	getCategorySmartBusinessSession(Id businessId)	Gets the OsidSession associated with the category smart business service.
CustomerAdminSession	getCustomerAdminSession()	Gets the OsidSession associated with the customer administration service.
CustomerAdminSession	getCustomerAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the customer administration service for the given business.
CustomerBusinessAssignmentSession	getCustomerBusinessAssignmentSession()	Gets the OsidSession associated with assigning customers to businesses.
CustomerBusinessSession	getCustomerBusinessSession()	Gets the OsidSession to lookup customer/catalog mappings.
CustomerLookupSession	getCustomerLookupSession()	Gets the OsidSession associated with the customer lookup service.
CustomerLookupSession	getCustomerLookupSessionForBusiness(Id businessId)	Gets the OsidSession associated with the customer lookup service for the given business.
CustomerNotificationSession	getCustomerNotificationSession(CustomerReceiver customerReceiver)	Gets the OsidSession associated with the customer notification service.
CustomerNotificationSession	getCustomerNotificationSessionForBusiness(CustomerReceiver customerReceiver, Id businessId)	Gets the OsidSession associated with the customer notification service for the given business.
CustomerQuerySession	getCustomerQuerySession()	Gets the OsidSession associated with the customer query service.
CustomerQuerySession	getCustomerQuerySessionForBusiness(Id businessId)	Gets the OsidSession associated with the customer query service for the given business.
CustomerSearchSession	getCustomerSearchSession()	Gets the OsidSession associated with the customer search service.
CustomerSearchSession	getCustomerSearchSessionForBusiness(Id businessId)	Gets the OsidSession associated with the customer search service for the given business.
CustomerSmartBusinessSession	getCustomerSmartBusinessSession(Id businessId)	Gets the OsidSession associated with the customer smart business service.
EntryAdminSession	getEntryAdminSession()	Gets the OsidSession associated with the entry administration service.
EntryAdminSession	getEntryAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the entry administration service for the given business.
EntryBusinessAssignmentSession	getEntryBusinessAssignmentSession()	Gets the OsidSession associated with assigning entries to businesses.
EntryBusinessSession	getEntryBusinessSession()	Gets the OsidSession to lookup entry/catalog mappings.
EntryLookupSession	getEntryLookupSession()	Gets the OsidSession associated with the entry lookup service.
EntryLookupSession	getEntryLookupSessionForBusiness(Id businessId)	Gets the OsidSession associated with the entry lookup service for the given business.
EntryNotificationSession	getEntryNotificationSession(EntryReceiver entryReceiver)	Gets the OsidSession associated with the entry notification service.
EntryNotificationSession	getEntryNotificationSessionForBusiness(EntryReceiver entryReceiver, Id businessId)	Gets the OsidSession associated with the entry notification service for the given business.
EntryQuerySession	getEntryQuerySession()	Gets the OsidSession associated with the entry query service.
EntryQuerySession	getEntryQuerySessionForBusiness(Id businessId)	Gets the OsidSession associated with the entry query service for the given business.
EntrySearchSession	getEntrySearchSession()	Gets the OsidSession associated with the entry search service.
EntrySearchSession	getEntrySearchSessionForBusiness(Id businessId)	Gets the OsidSession associated with the entry search service for the given business.
EntrySmartBusinessSession	getEntrySmartBusinessSession(Id businessId)	Gets the OsidSession associated with the entry smart business service.
ItemAdminSession	getItemAdminSession()	Gets the OsidSession associated with the item administration service.
ItemAdminSession	getItemAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the item administration service for the given business.
ItemBusinessAssignmentSession	getItemBusinessAssignmentSession()	Gets the OsidSession associated with assigning items to businesses.
ItemBusinessSession	getItemBusinessSession()	Gets the OsidSession to lookup item/catalog mappings.
ItemLookupSession	getItemLookupSession()	Gets the OsidSession associated with the item lookup service.
ItemLookupSession	getItemLookupSessionForBusiness(Id businessId)	Gets the OsidSession associated with the item lookup service for the given business.
ItemNotificationSession	getItemNotificationSession(ItemReceiver itemReceiver)	Gets the OsidSession associated with the item notification service.
ItemNotificationSession	getItemNotificationSessionForBusiness(ItemReceiver itemReceiver, Id businessId)	Gets the OsidSession associated with the item notification service for the given business.
CustomerQuerySession	getItemQuerySession()	Gets the OsidSession associated with the item query service.
CustomerQuerySession	getItemQuerySessionForBusiness(Id businessId)	Gets the OsidSession associated with the item query service for the given business.
ItemSearchSession	getItemSearchSession()	Gets the OsidSession associated with the item search service.
ItemSearchSession	getItemSearchSessionForBusiness(Id businessId)	Gets the OsidSession associated with the item search service for the given business.
ItemSmartBusinessSession	getItemSmartBusinessSession(Id businessId)	Gets the OsidSession associated with the item smart business service.
PeriodAdminSession	getPeriodAdminSession()	Gets the OsidSession associated with the period administration service.
PeriodAdminSession	getPeriodAdminSessionForBusiness(Id businessId)	Gets the OsidSession associated with the period administration service for the given business.
PeriodBusinessAssignmentSession	getPeriodBusinessAssignmentSession()	Gets the OsidSession associated with assigning periods to businesses.
PeriodBusinessSession	getPeriodBusinessSession()	Gets the OsidSession to lookup period/catalog mappings.
PeriodLookupSession	getPeriodLookupSession()	Gets the OsidSession associated with the period lookup service.
PeriodLookupSession	getPeriodLookupSessionForBusiness(Id businessId)	Gets the OsidSession associated with the period lookup service for the given business.
PeriodNotificationSession	getPeriodNotificationSession(PeriodReceiver periodReceiver)	Gets the OsidSession associated with the period notification service.
PeriodNotificationSession	getPeriodNotificationSessionForBusiness(PeriodReceiver periodReceiver, Id businessId)	Gets the OsidSession associated with the period notification service for the given business.
PeriodQuerySession	getPeriodQuerySession()	Gets the OsidSession associated with the period query service.
PeriodQuerySession	getPeriodQuerySessionForBusiness(Id businessId)	Gets the OsidSession associated with the period query service for the given business.
PeriodSearchSession	getPeriodSearchSession()	Gets the OsidSession associated with the period search service.
PeriodSearchSession	getPeriodSearchSessionForBusiness(Id businessId)	Gets the OsidSession associated with the period search service for the given business.
PeriodSmartBusinessSession	getPeriodSmartBusinessSession(Id businessId)	Gets the OsidSession associated with the period smart business service.

Methods inherited from interface BillingProfile

getBusinessRecordTypes, getBusinessSearchRecordTypes, getCategoryRecordTypes, getCategorySearchRecordTypes, getCustomerRecordTypes, getCustomerSearchRecordTypes, getEntryRecordTypes, getEntrySearchRecordTypes, getItemRecordTypes, getItemSearchRecordTypes, getPeriodRecordTypes, getPeriodSearchRecordTypes, supportsBillingBatch, supportsBillingPayment, supportsBusinessAdmin, supportsBusinessHierarchy, supportsBusinessHierarchyDesign, supportsBusinessLookup, supportsBusinessNotification, supportsBusinessQuery, supportsBusinessRecordType, supportsBusinessSearch, supportsBusinessSearchRecordType, supportsCategoryAdmin, supportsCategoryBusiness, supportsCategoryBusinessAssignment, supportsCategoryLookup, supportsCategoryNotification, supportsCategoryQuery, supportsCategoryRecordType, supportsCategorySearch, supportsCategorySearchRecordType, supportsCategorySmartBusiness, supportsCustomerAdmin, supportsCustomerBusiness, supportsCustomerBusinessAssignment, supportsCustomerLookup, supportsCustomerNotification, supportsCustomerQuery, supportsCustomerRecordType, supportsCustomerSearch, supportsCustomerSearchRecordType, supportsCustomerSmartBusiness, supportsEntryAdmin, supportsEntryBusiness, supportsEntryBusinessAssignment, supportsEntryLookup, supportsEntryNotification, supportsEntryQuery, supportsEntryRecordType, supportsEntrySearch, supportsEntrySearchRecordType, supportsEntrySmartBusiness, supportsItemAdmin, supportsItemBusiness, supportsItemBusinessAssignment, supportsItemLookup, supportsItemNotification, supportsItemQuery, supportsItemRecordType, supportsItemSearch, supportsItemSearchRecordType, supportsItemSmartBusiness, supportsPeriodAdmin, supportsPeriodBusiness, supportsPeriodBusinessAssignment, supportsPeriodLookup, supportsPeriodNotification, supportsPeriodQuery, supportsPeriodRecordType, supportsPeriodSearch, supportsPeriodSearchRecordType, supportsPeriodSmartBusiness, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getBusinessRecordTypes()	Gets the supported Business record types.
TypeList	getBusinessSearchRecordTypes()	Gets the supported Business search record types.
TypeList	getCategoryRecordTypes()	Gets the supported Category record types.
TypeList	getCategorySearchRecordTypes()	Gets the supported Category search record types.
TypeList	getCustomerRecordTypes()	Gets the supported Customer record types.
TypeList	getCustomerSearchRecordTypes()	Gets the supported Customer search record types.
TypeList	getEntryRecordTypes()	Gets the supported Entry record types.
TypeList	getEntrySearchRecordTypes()	Gets the supported Entry search record types.
TypeList	getItemRecordTypes()	Gets the supported Item record types.
TypeList	getItemSearchRecordTypes()	Gets the supported Item search record types.
TypeList	getPeriodRecordTypes()	Gets the supported Period record types.
TypeList	getPeriodSearchRecordTypes()	Gets the supported Period search record types.
boolean	supportsBillingBatch()	Tests for the availability of a billing batch service.
boolean	supportsBillingPayment()	Tests for the availability of a billing payment service.
boolean	supportsBusinessAdmin()	Tests if business administrative service is supported.
boolean	supportsBusinessHierarchy()	Tests for the availability of a business hierarchy traversal service.
boolean	supportsBusinessHierarchyDesign()	Tests for the availability of a business hierarchy design service.
boolean	supportsBusinessLookup()	Tests if looking up businesses is supported.
boolean	supportsBusinessNotification()	Tests if a business notification service is supported.
boolean	supportsBusinessQuery()	Tests if querying businesses is supported.
boolean	supportsBusinessRecordType(Type businessRecordType)	Tests if the given Business record type is supported.
boolean	supportsBusinessSearch()	Tests if searching businesses is supported.
boolean	supportsBusinessSearchRecordType(Type businessSearchRecordType)	Tests if the given Business search record type is supported.
boolean	supportsCategoryAdmin()	Tests if category administrative service is supported.
boolean	supportsCategoryBusiness()	Tests if a category cataloging service is supported.
boolean	supportsCategoryBusinessAssignment()	Tests if a category cataloging service is supported.
boolean	supportsCategoryLookup()	Tests if looking up categories is supported.
boolean	supportsCategoryNotification()	Tests if a category notification service is supported.
boolean	supportsCategoryQuery()	Tests if querying categories is supported.
boolean	supportsCategoryRecordType(Type categoryRecordType)	Tests if the given Category record type is supported.
boolean	supportsCategorySearch()	Tests if searching categories is supported.
boolean	supportsCategorySearchRecordType(Type categorySearchRecordType)	Tests if the given Category search record type is supported.
boolean	supportsCategorySmartBusiness()	Tests if a category smart business session is available.
boolean	supportsCustomerAdmin()	Tests if customer administrative service is supported.
boolean	supportsCustomerBusiness()	Tests if a businessing service is supported.
boolean	supportsCustomerBusinessAssignment()	Tests if a businessing service is supported.
boolean	supportsCustomerLookup()	Tests if looking up customers is supported.
boolean	supportsCustomerNotification()	Tests if a customer notification service is supported.
boolean	supportsCustomerQuery()	Tests if querying customers is supported.
boolean	supportsCustomerRecordType(Type customerRecordType)	Tests if the given Customer record type is supported.
boolean	supportsCustomerSearch()	Tests if searching customers is supported.
boolean	supportsCustomerSearchRecordType(Type customerSearchRecordType)	Tests if the given Customer search record type is supported.
boolean	supportsCustomerSmartBusiness()	Tests if a customer smart business session is available.
boolean	supportsEntryAdmin()	Tests if entry administrative service is supported.
boolean	supportsEntryBusiness()	Tests if an entry cataloging service is supported.
boolean	supportsEntryBusinessAssignment()	Tests if an entry cataloging service is supported.
boolean	supportsEntryLookup()	Tests if looking up entries is supported.
boolean	supportsEntryNotification()	Tests if an entry notification service is supported.
boolean	supportsEntryQuery()	Tests if querying entries is supported.
boolean	supportsEntryRecordType(Type entryRecordType)	Tests if the given Entry record type is supported.
boolean	supportsEntrySearch()	Tests if searching entries is supported.
boolean	supportsEntrySearchRecordType(Type entrySearchRecordType)	Tests if the given Entry search record type is supported.
boolean	supportsEntrySmartBusiness()	Tests if an entry smart business session is available.
boolean	supportsItemAdmin()	Tests if an item administrative service is supported.
boolean	supportsItemBusiness()	Tests if an item cataloging service is supported.
boolean	supportsItemBusinessAssignment()	Tests if an item cataloging service is supported.
boolean	supportsItemLookup()	Tests if looking up items is supported.
boolean	supportsItemNotification()	Tests if an item notification service is supported.
boolean	supportsItemQuery()	Tests if querying items is supported.
boolean	supportsItemRecordType(Type itemRecordType)	Tests if the given Item record type is supported.
boolean	supportsItemSearch()	Tests if searching items is supported.
boolean	supportsItemSearchRecordType(Type itemSearchRecordType)	Tests if the given Item search record type is supported.
boolean	supportsItemSmartBusiness()	Tests if an item smart business session is available.
boolean	supportsPeriodAdmin()	Tests if period administrative service is supported.
boolean	supportsPeriodBusiness()	Tests if a period cataloging service is supported.
boolean	supportsPeriodBusinessAssignment()	Tests if a period cataloging service is supported.
boolean	supportsPeriodLookup()	Tests if looking up periods is supported.
boolean	supportsPeriodNotification()	Tests if a period notification service is supported.
boolean	supportsPeriodQuery()	Tests if querying periods is supported.
boolean	supportsPeriodRecordType(Type periodRecordType)	Tests if the given Period record type is supported.
boolean	supportsPeriodSearch()	Tests if searching periods is supported.
boolean	supportsPeriodSearchRecordType(Type periodSearchRecordType)	Tests if the given Period search record type is supported.
boolean	supportsPeriodSmartBusiness()	Tests if a period smart business session is available.
boolean	supportsVisibleFederation()	Tests if any business federation is exposed.

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

getCustomerLookupSession

CustomerLookupSession getCustomerLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the customer lookup service.

Returns:

a CustomerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerLookup() is false

Compliance:

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

getCustomerLookupSessionForBusiness

CustomerLookupSession getCustomerLookupSessionForBusiness(Id businessId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the customer lookup service for the given business.

Parameters:

businessId - the Id of the business

Returns:

a CustomerLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerLookup() or supportsVisibleFederation() is false

Compliance:

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

getCustomerQuerySession

CustomerQuerySession getCustomerQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the customer query service.

Returns:

a CustomerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerQuery() is false

Compliance:

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

getCustomerQuerySessionForBusiness

CustomerQuerySession getCustomerQuerySessionForBusiness(Id businessId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the customer query service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a CustomerQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerQuery() or supportsVisibleFederation() is false

Compliance:

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

getCustomerSearchSession

CustomerSearchSession getCustomerSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the customer search service.

Returns:

a CustomerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerSearch() is false

Compliance:

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

getCustomerSearchSessionForBusiness

CustomerSearchSession getCustomerSearchSessionForBusiness(Id businessId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the customer search service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a CustomerSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerSearch() or supportsVisibleFederation() is false

Compliance:

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

getCustomerAdminSession

CustomerAdminSession getCustomerAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the customer administration service.

Returns:

a CustomerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerAdmin() is false

Compliance:

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

getCustomerAdminSessionForBusiness

CustomerAdminSession getCustomerAdminSessionForBusiness(Id businessId)
                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a CustomerAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCustomerNotificationSession

CustomerNotificationSession getCustomerNotificationSession(CustomerReceiver customerReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the customer notification service.

Parameters:

customerReceiver - the notification callback

Returns:

a CustomerNotificationSession

Throws:

NullArgumentException - customerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerNotification() is false

Compliance:

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

getCustomerNotificationSessionForBusiness

CustomerNotificationSession getCustomerNotificationSessionForBusiness(CustomerReceiver customerReceiver,
 Id businessId)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the customer notification service for the given business.

Parameters:

customerReceiver - the notification callback

businessId - the Id of the Business

Returns:

a CustomerNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - customerReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerNotification() or supportsVisibleFederation() is false

Compliance:

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

getCustomerBusinessSession

CustomerBusinessSession getCustomerBusinessSession()
                                            throws OperationFailedException

Gets the OsidSession to lookup customer/catalog mappings.

Returns:

a CustomerCustomerBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBusiness() is false

Compliance:

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

getCustomerBusinessAssignmentSession

CustomerBusinessAssignmentSession getCustomerBusinessAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning customers to businesses.

Returns:

a CustomerBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBusinessAssignment() is false

Compliance:

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

getCustomerSmartBusinessSession

CustomerSmartBusinessSession getCustomerSmartBusinessSession(Id businessId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the customer smart business service.

Parameters:

businessId - the Id of the Business

Returns:

a CustomerSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getItemLookupSession

ItemLookupSession getItemLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the item lookup service.

Returns:

an ItemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() is false

Compliance:

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

getItemLookupSessionForBusiness

ItemLookupSession getItemLookupSessionForBusiness(Id businessId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item lookup service for the given business.

Parameters:

businessId - the Id of the business

Returns:

an ItemLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() or supportsVisibleFederation() is false

Compliance:

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

getItemQuerySession

CustomerQuerySession getItemQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the item query service.

Returns:

an ItemQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() is false

Compliance:

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

getItemQuerySessionForBusiness

CustomerQuerySession getItemQuerySessionForBusiness(Id businessId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item query service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

an ItemQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() or supportsVisibleFederation() is false

Compliance:

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

getItemSearchSession

ItemSearchSession getItemSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the item search service.

Returns:

an ItemSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() is false

Compliance:

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

getItemSearchSessionForBusiness

ItemSearchSession getItemSearchSessionForBusiness(Id businessId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item search service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

an ItemSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() or supportsVisibleFederation() is false

Compliance:

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

getItemAdminSession

ItemAdminSession getItemAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the item administration service.

Returns:

an ItemAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() is false

Compliance:

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

getItemAdminSessionForBusiness

ItemAdminSession getItemAdminSessionForBusiness(Id businessId)
                                         throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an ItemAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getItemNotificationSession

ItemNotificationSession getItemNotificationSession(ItemReceiver itemReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the item notification service.

Parameters:

itemReceiver - the notification callback

Returns:

an ItemNotificationSession

Throws:

NullArgumentException - itemReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() is false

Compliance:

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

getItemNotificationSessionForBusiness

ItemNotificationSession getItemNotificationSessionForBusiness(ItemReceiver itemReceiver,
 Id businessId)
                                                       throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item notification service for the given business.

Parameters:

itemReceiver - the notification callback

businessId - the Id of the Business

Returns:

an ItemNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - itemReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() or supportsVisibleFederation() is false

Compliance:

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

getItemBusinessSession

ItemBusinessSession getItemBusinessSession()
                                    throws OperationFailedException

Gets the OsidSession to lookup item/catalog mappings.

Returns:

an ItemBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBusiness() is false

Compliance:

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

getItemBusinessAssignmentSession

ItemBusinessAssignmentSession getItemBusinessAssignmentSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with assigning items to businesses.

Returns:

an ItemBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBusinessAssignment() is false

Compliance:

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

getItemSmartBusinessSession

ItemSmartBusinessSession getItemSmartBusinessSession(Id businessId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the item smart business service.

Parameters:

businessId - the Id of the Business

Returns:

an ItemSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getCategoryLookupSession

CategoryLookupSession getCategoryLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the category lookup service.

Returns:

a CategorySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryLookup() is false

Compliance:

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

getCategoryLookupSessionForBusiness

CategoryLookupSession getCategoryLookupSessionForBusiness(Id businessId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the category lookup service for the given business.

Parameters:

businessId - the Id of the business

Returns:

a CategoryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryLookup() or supportsVisibleFederation() is false

Compliance:

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

getCategoryQuerySession

CustomerQuerySession getCategoryQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the category query service.

Returns:

a CategoryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryQuery() is false

Compliance:

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

getCategoryQuerySessionForBusiness

CustomerQuerySession getCategoryQuerySessionForBusiness(Id businessId)
                                                 throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the category query service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a CategoryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryQuery() or supportsVisibleFederation() is false

Compliance:

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

getCategorySearchSession

CategorySearchSession getCategorySearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the category search service.

Returns:

a CategorySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategorySearch() is false

Compliance:

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

getCategorySearchSessionForBusiness

CategorySearchSession getCategorySearchSessionForBusiness(Id businessId)
                                                   throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the category search service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a CategorySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategorySearch() or supportsVisibleFederation() is false

Compliance:

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

getCategoryAdminSession

CategoryAdminSession getCategoryAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the category administration service.

Returns:

a CategoryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryAdmin() is false

Compliance:

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

getCategoryAdminSessionForBusiness

CategoryAdminSession getCategoryAdminSessionForBusiness(Id businessId)
                                                 throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a CategoryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCategoryNotificationSession

CategoryNotificationSession getCategoryNotificationSession(CategoryReceiver categoryReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the category notification service.

Parameters:

categoryReceiver - the notification callback

Returns:

a CategoryNotificationSession

Throws:

NullArgumentException - categoryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryNotification() is false

Compliance:

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

getCategoryNotificationSessionForBusiness

CategoryNotificationSession getCategoryNotificationSessionForBusiness(CategoryReceiver categoryReceiver,
 Id businessId)
                                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the category notification service for the given business.

Parameters:

categoryReceiver - the notification callback

businessId - the Id of the Business

Returns:

a CategoryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - categoryReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryNotification() or supportsVisibleFederation() is false

Compliance:

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

getCategoryBusinessSession

CategoryBusinessSession getCategoryBusinessSession()
                                            throws OperationFailedException

Gets the OsidSession to lookup category/catalog mappings.

Returns:

a CategoryBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBusiness() is false

Compliance:

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

getCategoryBusinessAssignmentSession

CategoryBusinessAssignmentSession getCategoryBusinessAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning categories to businesses.

Returns:

a CategoryBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBusinessAssignment() is false

Compliance:

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

getCategorySmartBusinessSession

CategorySmartBusinessSession getCategorySmartBusinessSession(Id businessId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the category smart business service.

Parameters:

businessId - the Id of the Business

Returns:

a CategorySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategorySmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getEntryLookupSession

EntryLookupSession getEntryLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the entry lookup service.

Returns:

an EntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() is false

Compliance:

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

getEntryLookupSessionForBusiness

EntryLookupSession getEntryLookupSessionForBusiness(Id businessId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the entry lookup service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

an EntryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getEntryQuerySession

EntryQuerySession getEntryQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the entry query service.

Returns:

an EntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() is false

Compliance:

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

getEntryQuerySessionForBusiness

EntryQuerySession getEntryQuerySessionForBusiness(Id businessId)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the entry query service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

an EntryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getEntrySearchSession

EntrySearchSession getEntrySearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the entry search service.

Returns:

an EntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() is false

Compliance:

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

getEntrySearchSessionForBusiness

EntrySearchSession getEntrySearchSessionForBusiness(Id businessId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the entry search service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

an EntrySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getEntryAdminSession

EntryAdminSession getEntryAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the entry administration service.

Returns:

an EntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() is false

Compliance:

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

getEntryAdminSessionForBusiness

EntryAdminSession getEntryAdminSessionForBusiness(Id businessId)
                                           throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

an EntryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEntryNotificationSession

EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the entry notification service.

Parameters:

entryReceiver - the notification callback

Returns:

an EntryNotificationSession

Throws:

NullArgumentException - entryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() is false

Compliance:

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

getEntryNotificationSessionForBusiness

EntryNotificationSession getEntryNotificationSessionForBusiness(EntryReceiver entryReceiver,
 Id businessId)
                                                         throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the entry notification service for the given business.

Parameters:

entryReceiver - the notification callback

businessId - the Id of the Business

Returns:

an EntryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - entryReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getEntryBusinessSession

EntryBusinessSession getEntryBusinessSession()
                                      throws OperationFailedException

Gets the OsidSession to lookup entry/catalog mappings.

Returns:

an EntryBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBusiness() is false

Compliance:

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

getEntryBusinessAssignmentSession

EntryBusinessAssignmentSession getEntryBusinessAssignmentSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with assigning entries to businesses.

Returns:

an EntryBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBusinessAssignment() is false

Compliance:

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

getEntrySmartBusinessSession

EntrySmartBusinessSession getEntrySmartBusinessSession(Id businessId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the entry smart business service.

Parameters:

businessId - the Id of the Business

Returns:

an EntrySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getPeriodLookupSession

PeriodLookupSession getPeriodLookupSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the period lookup service.

Returns:

a PeriodLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodLookup() is false

Compliance:

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

getPeriodLookupSessionForBusiness

PeriodLookupSession getPeriodLookupSessionForBusiness(Id businessId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the period lookup service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a PeriodLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodLookup() or supportsVisibleFederation() is false

Compliance:

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

getPeriodQuerySession

PeriodQuerySession getPeriodQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the period query service.

Returns:

a PeriodQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodQuery() is false

Compliance:

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

getPeriodQuerySessionForBusiness

PeriodQuerySession getPeriodQuerySessionForBusiness(Id businessId)
                                             throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the period query service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a PeriodQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodQuery() or supportsVisibleFederation() is false

Compliance:

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

getPeriodSearchSession

PeriodSearchSession getPeriodSearchSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the period search service.

Returns:

a PeriodSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodSearch() is false

Compliance:

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

getPeriodSearchSessionForBusiness

PeriodSearchSession getPeriodSearchSessionForBusiness(Id businessId)
                                               throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the period search service for the given business.

Parameters:

businessId - the Id of the Business

Returns:

a PeriodSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodSearch() or supportsVisibleFederation() is false

Compliance:

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

getPeriodAdminSession

PeriodAdminSession getPeriodAdminSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the period administration service.

Returns:

a PeriodAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodAdmin() is false

Compliance:

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

getPeriodAdminSessionForBusiness

PeriodAdminSession getPeriodAdminSessionForBusiness(Id businessId)
                                             throws NotFoundException,
OperationFailedException

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

Parameters:

businessId - the Id of the Business

Returns:

a PeriodAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPeriodNotificationSession

PeriodNotificationSession getPeriodNotificationSession(PeriodReceiver periodReceiver)
                                                throws OperationFailedException

Gets the OsidSession associated with the period notification service.

Parameters:

periodReceiver - the notification callback

Returns:

a PeriodNotificationSession

Throws:

NullArgumentException - periodReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodNotification() is false

Compliance:

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

getPeriodNotificationSessionForBusiness

PeriodNotificationSession getPeriodNotificationSessionForBusiness(PeriodReceiver periodReceiver,
 Id businessId)
                                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the period notification service for the given business.

Parameters:

periodReceiver - the notification callback

businessId - the Id of the Business

Returns:

a PeriodNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - periodReceiver or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodNotification() or supportsVisibleFederation() is false

Compliance:

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

getPeriodBusinessSession

PeriodBusinessSession getPeriodBusinessSession()
                                        throws OperationFailedException

Gets the OsidSession to lookup period/catalog mappings.

Returns:

a PeriodBusinessSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodBusiness() is false

Compliance:

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

getPeriodBusinessAssignmentSession

PeriodBusinessAssignmentSession getPeriodBusinessAssignmentSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning periods to businesses.

Returns:

a PeriodBusinessAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodBusinessAssignment() is false

Compliance:

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

getPeriodSmartBusinessSession

PeriodSmartBusinessSession getPeriodSmartBusinessSession(Id businessId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the period smart business service.

Parameters:

businessId - the Id of the Business

Returns:

a PeriodSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getBusinessLookupSession

BusinessLookupSession getBusinessLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the business lookup service.

Returns:

a BusinessLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessLookup() is false

Compliance:

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

getBusinessQuerySession

BusinessQuerySession getBusinessQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the business query service.

Returns:

a BusinessQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessQuery() is false

Compliance:

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

getBusinessSearchSession

BusinessSearchSession getBusinessSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the business search service.

Returns:

a BusinessSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessSearch() is false

Compliance:

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

getBusinessAdminSession

BusinessAdminSession getBusinessAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the business administrative service.

Returns:

a BusinessAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessAdmin() is false

Compliance:

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

getBusinessNotificationSession

BusinessNotificationSession getBusinessNotificationSession(BusinessReceiver businessReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the business notification service.

Parameters:

businessReceiver - the notification callback

Returns:

a BusinessNotificationSession

Throws:

NullArgumentException - businessReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessNotification() is false

Compliance:

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

getBusinessHierarchySession

BusinessHierarchySession getBusinessHierarchySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the business hierarchy service.

Returns:

a BusinessHierarchySession for businesses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchy() is false

Compliance:

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

getBusinessHierarchyDesignSession

BusinessHierarchyDesignSession getBusinessHierarchyDesignSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the business hierarchy design service.

Returns:

a HierarchyDesignSession for businesses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchyDesign() is false

Compliance:

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

getBillingBatchManager

BillingBatchManager getBillingBatchManager()
                                    throws OperationFailedException

Gets a BillingBatchManager .

Returns:

a BillingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingBatch() is false

Compliance:

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

getBillingPaymentManager

BillingPaymentManager getBillingPaymentManager()
                                        throws OperationFailedException

Gets a BillingPaymentManager .

Returns:

a BillingPaymentManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingPayment() is false

Compliance:

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