org.osid.billing

Interface BillingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, BillingProfile, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

public interface BillingProxyManager
extends OsidProxyManager, BillingProfile

The customer manager provides access to customer management sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information within a server application environment. 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

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.billing.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCustomerLookupSession

CustomerLookupSession getCustomerLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the customer lookup service.

Parameters:

proxy - proxy

Returns:

a CustomerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerLookup() is false

Compliance:

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

getCustomerLookupSessionForBusiness

CustomerLookupSession getCustomerLookupSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a CustomerLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerLookup() or supportsVisibleFederation() is false

Compliance:

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

getCustomerQuerySession

CustomerQuerySession getCustomerQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the customer query service.

Parameters:

proxy - proxy

Returns:

a CustomerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerQuery() is false

Compliance:

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

getCustomerQuerySessionForBusiness

CustomerQuerySession getCustomerQuerySessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CustomerQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerQuery() or supportsVisibleFederation() is false

Compliance:

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

getCustomerSearchSession

CustomerSearchSession getCustomerSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the customer search service.

Parameters:

proxy - proxy

Returns:

a CustomerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerSearch() is false

Compliance:

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

getCustomerSearchSessionForBusiness

CustomerSearchSession getCustomerSearchSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CustomerSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerSearch() or supportsVisibleFederation() is false

Compliance:

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

getCustomerAdminSession

CustomerAdminSession getCustomerAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the customer administration service.

Parameters:

proxy - proxy

Returns:

a CustomerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerAdmin() is false

Compliance:

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

getCustomerAdminSessionForBusiness

CustomerAdminSession getCustomerAdminSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CustomerAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCustomerNotificationSession

CustomerNotificationSession getCustomerNotificationSession(CustomerReceiver customerReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the customer notification service.

Parameters:

customerReceiver - the notification callback

proxy - proxy

Returns:

a CustomerNotificationSession

Throws:

NullArgumentException - customerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerNotification() is false

Compliance:

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

getCustomerNotificationSessionForBusiness

CustomerNotificationSession getCustomerNotificationSessionForBusiness(CustomerReceiver customerReceiver,
                                                                    Id businessId,
                                                                    Proxy proxy)
                                                                      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

proxy - proxy

Returns:

a CustomerNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - customerReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerNotification() or supportsVisibleFederation() is false

Compliance:

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

getCustomerBusinessSession

CustomerBusinessSession getCustomerBusinessSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup customer/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CustomerBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBusiness() is false

Compliance:

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

getCustomerBusinessAssignmentSession

CustomerBusinessAssignmentSession getCustomerBusinessAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning customers to businesses.

Parameters:

proxy - proxy

Returns:

a CustomerBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerBusinessAssignment() is false

Compliance:

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

getCustomerSmartBusinessSession

CustomerSmartBusinessSession getCustomerSmartBusinessSession(Id businessId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the customer smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CustomerSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCustomerSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getItemLookupSession

ItemLookupSession getItemLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the item lookup service.

Parameters:

proxy - proxy

Returns:

an ItemSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() is false

Compliance:

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

getItemLookupSessionForBusiness

ItemLookupSession getItemLookupSessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

an ItemLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() or supportsVisibleFederation() is false

Compliance:

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

getItemQuerySession

ItemQuerySession getItemQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the item query service.

Parameters:

proxy - proxy

Returns:

an ItemQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() is false

Compliance:

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

getItemQuerySessionForBusiness

ItemQuerySession getItemQuerySessionForBusiness(Id businessId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ItemQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() or supportsVisibleFederation() is false

Compliance:

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

getItemSearchSession

ItemSearchSession getItemSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the item search service.

Parameters:

proxy - proxy

Returns:

an ItemSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() is false

Compliance:

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

getItemSearchSessionForBusiness

ItemSearchSession getItemSearchSessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ItemSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() or supportsVisibleFederation() is false

Compliance:

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

getItemAdminSession

ItemAdminSession getItemAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the item administration service.

Parameters:

proxy - proxy

Returns:

an ItemAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() is false

Compliance:

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

getItemAdminSessionForBusiness

ItemAdminSession getItemAdminSessionForBusiness(Id businessId,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ItemAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() or supportsVisibleFederation() is false

Compliance:

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

getItemNotificationSession

ItemNotificationSession getItemNotificationSession(ItemReceiver itemReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the item notification service.

Parameters:

itemReceiver - the notification callback

proxy - proxy

Returns:

an ItemNotificationSession

Throws:

NullArgumentException - itemReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() is false

Compliance:

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

getItemNotificationSessionForBusiness

ItemNotificationSession getItemNotificationSessionForBusiness(ItemReceiver itemReceiver,
                                                            Id businessId,
                                                            Proxy proxy)
                                                              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

proxy - proxy

Returns:

an ItemNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - itemReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() or supportsVisibleFederation() is false

Compliance:

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

getItemBusinessSession

ItemBusinessSession getItemBusinessSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession to lookup item/catalog mappings.

Parameters:

proxy - proxy

Returns:

an ItemCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemCatalog() is false

Compliance:

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

getItemBusinessAssignmentSession

ItemBusinessAssignmentSession getItemBusinessAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with assigning items to businesses.

Parameters:

proxy - proxy

Returns:

an ItemCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemCatalogAssignment() is false

Compliance:

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

getItemSmartBusinessSession

ItemSmartBusinessSession getItemSmartBusinessSession(Id businessId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the item smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an ItemSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getCategoryLookupSession

CategoryLookupSession getCategoryLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the category lookup service.

Parameters:

proxy - proxy

Returns:

a CategorySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryLookup() is false

Compliance:

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

getCategoryLookupSessionForBusiness

CategoryLookupSession getCategoryLookupSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a CategoryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryLookup() or supportsVisibleFederation() is false

Compliance:

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

getCategoryQuerySession

CategoryQuerySession getCategoryQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the category query service.

Parameters:

proxy - proxy

Returns:

a CategoryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryQuery() is false

Compliance:

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

getCategoryQuerySessionForBusiness

CategoryQuerySession getCategoryQuerySessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CategoryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryQuery() or supportsVisibleFederation() is false

Compliance:

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

getCategorySearchSession

CategorySearchSession getCategorySearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the category search service.

Parameters:

proxy - proxy

Returns:

a CategorySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategorySearch() is false

Compliance:

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

getCategorySearchSessionForBusiness

CategorySearchSession getCategorySearchSessionForBusiness(Id businessId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CategorySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategorySearch() or supportsVisibleFederation() is false

Compliance:

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

getCategoryAdminSession

CategoryAdminSession getCategoryAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the category administration service.

Parameters:

proxy - proxy

Returns:

a CategoryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryAdmin() is false

Compliance:

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

getCategoryAdminSessionForBusiness

CategoryAdminSession getCategoryAdminSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CategoryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCategoryNotificationSession

CategoryNotificationSession getCategoryNotificationSession(CategoryReceiver categoryReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the category notification service.

Parameters:

categoryReceiver - the notification callback

proxy - proxy

Returns:

a CategoryNotificationSession

Throws:

NullArgumentException - categoryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryNotification() is false

Compliance:

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

getCategoryNotificationSessionForBusiness

CategoryNotificationSession getCategoryNotificationSessionForBusiness(CategoryReceiver categoryReceiver,
                                                                    Id businessId,
                                                                    Proxy proxy)
                                                                      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

proxy - proxy

Returns:

a CategoryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - categoryReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryNotification() or supportsVisibleFederation() is false

Compliance:

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

getCategoryBusinessSession

CategoryBusinessSession getCategoryBusinessSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession to lookup category/catalog mappings.

Parameters:

proxy - proxy

Returns:

a CategoryBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBusiness() is false

Compliance:

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

getCategoryBusinessAssignmentSession

CategoryBusinessAssignmentSession getCategoryBusinessAssignmentSession(Proxy proxy)
                                                                       throws OperationFailedException

Gets the OsidSession associated with assigning categories to businesses.

Parameters:

proxy - proxy

Returns:

a CategoryBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategoryBusinessAssignment() is false

Compliance:

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

getCategorySmartBusinessSession

CategorySmartBusinessSession getCategorySmartBusinessSession(Id businessId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the category smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a CategorySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCategorySmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getEntryLookupSession

EntryLookupSession getEntryLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the entry lookup service.

Parameters:

proxy - proxy

Returns:

an EntryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() is false

Compliance:

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

getEntryLookupSessionForBusiness

EntryLookupSession getEntryLookupSessionForBusiness(Id businessId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an EntryLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getEntryQuerySession

EntryQuerySession getEntryQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the entry query service.

Parameters:

proxy - proxy

Returns:

an EntryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() is false

Compliance:

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

getEntryQuerySessionForBusiness

EntryQuerySession getEntryQuerySessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an EntryQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getEntrySearchSession

EntrySearchSession getEntrySearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the entry search service.

Parameters:

proxy - proxy

Returns:

an EntrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() is false

Compliance:

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

getEntrySearchSessionForBusiness

EntrySearchSession getEntrySearchSessionForBusiness(Id businessId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an EntrySearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getEntryAdminSession

EntryAdminSession getEntryAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the entry administration service.

Parameters:

proxy - proxy

Returns:

an EntryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() is false

Compliance:

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

getEntryAdminSessionForBusiness

EntryAdminSession getEntryAdminSessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an EntryAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEntryNotificationSession

EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the entry notification service.

Parameters:

entryReceiver - the notification callback

proxy - proxy

Returns:

an EntryNotificationSession

Throws:

NullArgumentException - entryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() is false

Compliance:

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

getEntryNotificationSessionForBusiness

EntryNotificationSession getEntryNotificationSessionForBusiness(EntryReceiver entryReceiver,
                                                              Id businessId,
                                                              Proxy proxy)
                                                                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

proxy - proxy

Returns:

an EntryNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - entryReceiver, businessId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getEntryBusinessSession

EntryBusinessSession getEntryBusinessSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession to lookup entry/catalog mappings.

Parameters:

proxy - proxy

Returns:

an EntryCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryCatalog() is false

Compliance:

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

getEntryBusinessAssignmentSession

EntryBusinessAssignmentSession getEntryBusinessAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning entries to businesses.

Parameters:

proxy - proxy

Returns:

an EntryCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryCatalogAssignment() is false

Compliance:

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

getEntrySmartBusinessSession

EntrySmartBusinessSession getEntrySmartBusinessSession(Id businessId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the entry smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

an EntrySmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getPeriodLookupSession

PeriodLookupSession getPeriodLookupSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the period lookup service.

Parameters:

proxy - proxy

Returns:

a PeriodLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodLookup() is false

Compliance:

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

getPeriodLookupSessionForBusiness

PeriodLookupSession getPeriodLookupSessionForBusiness(Id businessId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PeriodLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodLookup() or supportsVisibleFederation() is false

Compliance:

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

getPeriodQuerySession

PeriodQuerySession getPeriodQuerySession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the period query service.

Parameters:

proxy - proxy

Returns:

a PeriodQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodQuery() is false

Compliance:

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

getPeriodQuerySessionForBusiness

PeriodQuerySession getPeriodQuerySessionForBusiness(Id businessId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PeriodQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodQuery() or supportsVisibleFederation() is false

Compliance:

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

getPeriodSearchSession

PeriodSearchSession getPeriodSearchSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the period search service.

Parameters:

proxy - proxy

Returns:

a PeriodSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodSearch() is false

Compliance:

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

getPeriodSearchSessionForBusiness

PeriodSearchSession getPeriodSearchSessionForBusiness(Id businessId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PeriodSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodSearch() or supportsVisibleFederation() is false

Compliance:

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

getPeriodAdminSession

PeriodAdminSession getPeriodAdminSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the period administration service.

Parameters:

proxy - proxy

Returns:

a PeriodAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodAdmin() is false

Compliance:

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

getPeriodAdminSessionForBusiness

PeriodAdminSession getPeriodAdminSessionForBusiness(Id businessId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

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

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PeriodAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodAdmin() or supportsVisibleFederation() is false

Compliance:

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

getPeriodNotificationSession

PeriodNotificationSession getPeriodNotificationSession(PeriodReceiver periodReceiver,
                                                     Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the period notification service.

Parameters:

periodReceiver - the notification callback

proxy - proxy

Returns:

a PeriodNotificationSession

Throws:

NullArgumentException - periodReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodNotification() is false

Compliance:

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

getPeriodNotificationSessionForBusiness

PeriodNotificationSession getPeriodNotificationSessionForBusiness(PeriodReceiver periodReceiver,
                                                                Id businessId,
                                                                Proxy proxy)
                                                                  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

proxy - proxy

Returns:

a PeriodNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - periodReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodNotification() or supportsVisibleFederation() is false

Compliance:

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

getPeriodBusinessSession

PeriodBusinessSession getPeriodBusinessSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession to lookup period/catalog mappings.

Parameters:

proxy - proxy

Returns:

a PeriodCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodCatalog() is false

Compliance:

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

getPeriodBusinessAssignmentSession

PeriodBusinessAssignmentSession getPeriodBusinessAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning periods to businesses.

Parameters:

proxy - proxy

Returns:

a PeriodCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodCatalogAssignment() is false

Compliance:

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

getPeriodSmartBusinessSession

PeriodSmartBusinessSession getPeriodSmartBusinessSession(Id businessId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the period smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PeriodSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPeriodSmartBusiness() or supportsVisibleFederation() is false

Compliance:

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

getBusinessLookupSession

BusinessLookupSession getBusinessLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the business lookup service.

Parameters:

proxy - proxy

Returns:

a BusinessLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessLookup() is false

Compliance:

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

getBusinessQuerySession

BusinessQuerySession getBusinessQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the business query service.

Parameters:

proxy - proxy

Returns:

a BusinessQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessQuery() is false

Compliance:

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

getBusinessSearchSession

BusinessSearchSession getBusinessSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the business search service.

Parameters:

proxy - proxy

Returns:

a BusinessSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessSearch() is false

Compliance:

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

getBusinessAdminSession

BusinessAdminSession getBusinessAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the business administrative service.

Parameters:

proxy - proxy

Returns:

a BusinessAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessAdmin() is false

Compliance:

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

getBusinessNotificationSession

BusinessNotificationSession getBusinessNotificationSession(BusinessReceiver businessReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the business notification service.

Parameters:

businessReceiver - the notification callback

proxy - proxy

Returns:

a BusinessNotificationSession

Throws:

NullArgumentException - businessReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessNotification() is false

Compliance:

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

getBusinessHierarchySession

BusinessHierarchySession getBusinessHierarchySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the business hierarchy service.

Parameters:

proxy - proxy

Returns:

a BusinessHierarchySession for businesses

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchy() is false

Compliance:

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

getBusinessHierarchyDesignSession

BusinessHierarchyDesignSession getBusinessHierarchyDesignSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the business hierarchy design service.

Parameters:

proxy - proxy

Returns:

a HierarchyDesignSession for businesses

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBusinessHierarchyDesign() is false

Compliance:

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

getBillingBatchProxyManager

BillingBatchProxyManager getBillingBatchProxyManager()
                                                     throws OperationFailedException

Gets a BillingBatchProxyManager.

Returns:

a BillingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingBatch() is false

Compliance:

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

getBillingPaymentProxyManager

BillingPaymentProxyManager getBillingPaymentProxyManager()
                                                         throws OperationFailedException

Gets a BillingPaymentProxyManager.

Returns:

a BillingPaymentProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingPayment() is false

Compliance:

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