| Interface | osid.billing.EntrySmartBusinessSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An 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 | getEntryQuery | ||
| Description |
Gets an entry query. | ||
| Return | osid.billing.EntryQuery | the entry query | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntrySearchOrder | ||
| Description |
Gets an entry search order. | ||
| Return | osid.billing.EntrySearchOrder | the entry search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | applyEntryQuery | ||
| Description |
Applies an entry query to this business. | ||
| Parameters | osid.billing.EntryQuery | entryQuery | the entry query |
| Errors | NULL_ARGUMENT | entryQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | entryQuery not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | inspectEntryQuery | ||
| Description |
Gets an entry query inspector for this business. | ||
| Return | osid.billing.EntryQueryInspector | the entry query inspector | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure occurred | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | applyEntrySequencing | ||
| Description |
Applies an entry search order to this business. | ||
| Parameters | osid.billing.EntrySearchOrder | entrySearchOrder | the entry search order |
| Errors | NULL_ARGUMENT | entrySearchOrder is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | entrySearchOrder not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryQueryFromInspector | ||
| Description |
Gets an entry query from an inspector. | ||
| Parameters | osid.billing.EntryQueryInspector | entryQueryInspector | a query inspector |
| Return | osid.billing.EntryQuery | the entry query | |
| Errors | NULL_ARGUMENT | entryQueryInspector is null | |
| UNSUPPORTED | entryQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |