OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.CategoryBusinessSession
Implementsosid.OsidSession
Description

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

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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCategoryBusinessView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCategoryBusinessView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodgetCategoryIdsByBusiness
Description

Gets the list of Category Ids associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.id.IdListlist of related category Ids
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCategoriesByBusiness
Description

Gets the list of Categories associated with a Business.

Parametersosid.id.IdbusinessId Id of the Business
Returnosid.billing.CategoryListlist of related categories
ErrorsNOT_FOUND businessId is not found
NULL_ARGUMENT businessId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCategoryIdsByBusinesses
Description

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

Parametersosid.id.IdListbusinessIdslist of business Ids
Returnosid.id.IdListlist of category Ids
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCategoriesByBusinesses
Description

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

Parametersosid.id.IdListbusinessIdslist of business Ids
Returnosid.billing.CategoryListlist of categories
ErrorsNULL_ARGUMENT businessIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessIdsByCategory
Description

Gets the Business Ids mapped to a Category.

Parametersosid.id.IdcategoryId Id of a Category
Returnosid.id.IdListlist of businesses
ErrorsNOT_FOUND categoryId is not found
NULL_ARGUMENT categoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByCategory
Description

Gets the Business objects mapped to a Category.

Parametersosid.id.IdcategoryId Id of a Category
Returnosid.billing.BusinessListlist of businesses
ErrorsNOT_FOUND categoryId is not found
NULL_ARGUMENT categoryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.