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

This session manages queries and sequencing to create "smart" dynamic catalogs. An EntryQuery can be retrieved from this session and mapped to this Business to create a virtual collection of Entries. The entries may be sequenced using the EntrySearchOrder from this session.

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

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.
MethodgetEntryQuery
Description

Gets an entry query.

Returnosid.billing.EntryQuery the entry query
Compliancemandatory This method must be implemented.
MethodgetEntrySearchOrder
Description

Gets an entry search order.

Returnosid.billing.EntrySearchOrder the entry search order
Compliancemandatory This method must be implemented.
MethodapplyEntryQuery
Description

Applies an entry query to this business.

Parametersosid.billing.EntryQueryentryQuery the entry query
ErrorsNULL_ARGUMENT entryQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED entryQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectEntryQuery
Description

Gets an entry query inspector for this business.

Returnosid.billing.EntryQueryInspector the entry query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyEntrySequencing
Description

Applies an entry search order to this business.

Parametersosid.billing.EntrySearchOrderentrySearchOrder the entry search order
ErrorsNULL_ARGUMENT entrySearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED entrySearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetEntryQueryFromInspector
Description

Gets an entry query from an inspector.

Parametersosid.billing.EntryQueryInspectorentryQueryInspector a query inspector
Returnosid.billing.EntryQuery the entry query
ErrorsNULL_ARGUMENT entryQueryInspector is null
UNSUPPORTED entryQueryInspector is not of this service
Compliancemandatory This method must be implemented.