org.osid.billing

Interface CategoryBusinessSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CategoryBusinessSession
extends OsidSession

This session provides methods to retrieve Category to Business mappings. A Category may appear in multiple Business objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCategoryBusinessMappings() Tests if this user can perform lookups of category/business mappings.
BusinessList	getBusinessesByCategory(Id categoryId) Gets the Business objects mapped to a Category.
IdList	getBusinessIdsByCategory(Id categoryId) Gets the Business Ids mapped to a Category.
CategoryList	getCategoriesByBusiness(Id businessId) Gets the list of Categories associated with a Business.
CategoryList	getCategoriesByBusinesses(IdList businessIds) Gets the list of Categories corresponding to a list of Business objects.
IdList	getCategoryIdsByBusiness(Id businessId) Gets the list of Category Ids associated with a Business.
IdList	getCategoryIdsByBusinesses(IdList businessIds) Gets the list of Category Ids corresponding to a list of Business objects.
void	useComparativeCategoryBusinessView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCategoryBusinessView() A complete view of the Category and Business returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupCategoryBusinessMappings

boolean canLookupCategoryBusinessMappings()

Tests if this user can perform lookups of category/business mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCategoryBusinessView

void useComparativeCategoryBusinessView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCategoryBusinessView

void usePlenaryCategoryBusinessView()

A complete view of the Category and Business returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getCategoryIdsByBusiness

IdList getCategoryIdsByBusiness(Id businessId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Category Ids associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related category Ids

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCategoriesByBusiness

CategoryList getCategoriesByBusiness(Id businessId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the list of Categories associated with a Business.

Parameters:

businessId - Id of the Business

Returns:

list of related categories

Throws:

NotFoundException - businessId is not found

NullArgumentException - businessId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCategoryIdsByBusinesses

IdList getCategoryIdsByBusinesses(IdList businessIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Gets the list of Category Ids corresponding to a list of Business objects.

Parameters:

businessIds - list of business Ids

Returns:

list of category Ids

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCategoriesByBusinesses

CategoryList getCategoriesByBusinesses(IdList businessIds)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets the list of Categories corresponding to a list of Business objects.

Parameters:

businessIds - list of business Ids

Returns:

list of categories

Throws:

NullArgumentException - businessIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessIdsByCategory

IdList getBusinessIdsByCategory(Id categoryId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the Business Ids mapped to a Category.

Parameters:

categoryId - Id of a Category

Returns:

list of businesses

Throws:

NotFoundException - categoryId is not found

NullArgumentException - categoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBusinessesByCategory

BusinessList getBusinessesByCategory(Id categoryId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets the Business objects mapped to a Category.

Parameters:

categoryId - Id of a Category

Returns:

list of businesses

Throws:

NotFoundException - categoryId is not found

NullArgumentException - categoryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.