OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.IssueSmartFrontOfficeSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An IssueQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of Issues. The issues may be sequenced using the IssueSearchOrder from this session.

This FrontOffice has a default query that matches any issue and a default search order that specifies no sequencing. The queries may be examined using an IssueQueryInspector. The query may be modified by converting the inspector back to an IssueQuery.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe front office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartFrontOffices
Description

Tests if this user can manage smart frontOffices. A return of true does not guarantee successful authorization. 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 front office management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetIssueQuery
Description

Gets an issue query.

Returnosid.tracking.IssueQuerythe issue query
CompliancemandatoryThis method must be implemented.
MethodgetIssueSearchOrder
Description

Gets an issue search order.

Returnosid.tracking.IssueSearchOrderthe issue search order
CompliancemandatoryThis method must be implemented.
MethodapplyIssueQuery
Description

Applies an issue query to this front office.

Parametersosid.tracking.IssueQueryissueQuerythe issue query
ErrorsNULL_ARGUMENT issueQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED issueQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecIssueQuery
Description

Gets an issue query inspector for this front office.

Returnosid.tracking.IssueQueryInspectorthe issue query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyIssueSequencing
Description

Applies an issue search order to this front office.

Parametersosid.tracking.IssueSearchOrderissueSearchOrderthe issue search order
ErrorsNULL_ARGUMENT issueSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED issueSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetIssueQueryFromInspector
Description

Gets an issue query from an inspector.

Parametersosid.tracking.IssueQueryInspectorissueQueryInspectoran issue query inspector
Returnosid.tracking.IssueQuerythe issue query
ErrorsNULL_ARGUMENT issueQueryInspector is null
UNSUPPORTED issueQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.