| Interface | osid.billing.CategorySmartBusinessSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
| Method | getBusinessId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Business Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusiness | ||
| Description |
Gets the | ||
| Return | osid.billing.Business | the business | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canManageSmartBusinesses | ||
| 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 | ||
| Return | boolean | false if smart business management is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCategoryQuery | ||
| Description |
Gets a category query. | ||
| Return | osid.billing.CategoryQuery | the category query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCategorySearchOrder | ||
| Description |
Gets a category search order. | ||
| Return | osid.billing.CategorySearchOrder | the category search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | applyCategoryQuery | ||
| Description |
Applies a category query to this business. | ||
| Parameters | osid.billing.CategoryQuery | categoryQuery | the category query |
| Errors | NULL_ARGUMENT | categoryQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | categoryQuery not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | inspectCategoryQuery | ||
| Description |
Gets a category query inspector for this business. | ||
| Return | osid.billing.CategoryQueryInspector | the category query inspector | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | applyCategorySequencing | ||
| Description |
Applies a category search order to this business. | ||
| Parameters | osid.billing.CategorySearchOrder | categorySearchOrder | the category search order |
| Errors | NULL_ARGUMENT | categorySearchOrder is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | categorySearchOrder not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getCategoryQueryFromInspector | ||
| Description |
Gets a category query from an inspector. | ||
| Parameters | osid.billing.CategoryQueryInspector | categoryQueryInspector | a query inspector |
| Return | osid.billing.CategoryQuery | the category query | |
| Errors | NULL_ARGUMENT | categoryQueryInspector is null | |
| UNSUPPORTED | categoryQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |