OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.CategorySmartBusinessSession
Implementsosid.OsidSession
Used Byosid.billing.BillingManager
osid.billing.BillingProxyManager
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A CategoryQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Categories. The categories may be sequenced using the CategorySearchOrder from this session.

This Business has a default query that matches any category and a default search order that specifies no sequencing. The queries may be examined using a CategoryQueryInspector. The query may be modified by converting the inspector back to a CategoryQuery.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Id the Business Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.billing.Business the business
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanManageSmartBusinesses
Description

Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart business management is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetCategoryQuery
Description

Gets a category query.

Returnosid.billing.CategoryQuery the category query
Compliancemandatory This method must be implemented.
MethodgetCategorySearchOrder
Description

Gets a category search order.

Returnosid.billing.CategorySearchOrder the category search order
Compliancemandatory This method must be implemented.
MethodapplyCategoryQuery
Description

Applies a category query to this business.

Parametersosid.billing.CategoryQuerycategoryQuery the category query
ErrorsNULL_ARGUMENT categoryQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED categoryQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectCategoryQuery
Description

Gets a category query inspector for this business.

Returnosid.billing.CategoryQueryInspector the category query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyCategorySequencing
Description

Applies a category search order to this business.

Parametersosid.billing.CategorySearchOrdercategorySearchOrder the category search order
ErrorsNULL_ARGUMENT categorySearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED categorySearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetCategoryQueryFromInspector
Description

Gets a category query from an inspector.

Parametersosid.billing.CategoryQueryInspectorcategoryQueryInspector a query inspector
Returnosid.billing.CategoryQuery the category query
ErrorsNULL_ARGUMENT categoryQueryInspector is null
UNSUPPORTED categoryQueryInspector is not of this service
Compliancemandatory This method must be implemented.