OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.ActivitySmartBusinessSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActivityQuery can be retrieved from this session and mapped to this Business to create a virtual collection of Activities. The activities may be sequenced using the ActivitySearchOrder from this session.

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

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis 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
CompliancemandatoryThis method must be implemented.
MethodgetActivityQuery
Description

Gets an activity query.

Returnosid.financials.ActivityQuerythe activity query
CompliancemandatoryThis method must be implemented.
MethodgetActivitySearchOrder
Description

Gets an activity search order.

Returnosid.financials.ActivitySearchOrderthe activity search order
CompliancemandatoryThis method must be implemented.
MethodapplyActivityQuery
Description

Applies an activity query to this business.

Parametersosid.financials.ActivityQueryactivityQuerythe activity query
ErrorsNULL_ARGUMENT activityQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED activityQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectActivityQuery
Description

Gets an activity query inspector for this business.

Returnosid.financials.ActivityQueryInspectorthe activity query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyActivitySequencing
Description

Applies an activity search order to this business.

Parametersosid.financials.ActivitySearchOrderactivitySearchOrderthe activity search order
ErrorsNULL_ARGUMENT activitySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED activitySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivityQueryFromInspector
Description

Gets an activity query from an inspector.

Parametersosid.financials.ActivityQueryInspectoractivityQueryInspectora query inspector
Returnosid.financials.ActivityQuerythe activity query
ErrorsNULL_ARGUMENT activityQueryInspector is null
UNSUPPORTED activityQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.