OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CommissionSmartFoundrySession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A CommissionQuery can be retrieved from this session and foundryped to this Foundry to create a virtual collection of Commissions. The commissions may be sequenced using the CommissionSearchOrder from this session.

This Foundry has a default query that matches any commission and a default search order that specifies no sequencing. The queries may be examined using a CommissionQueryInspector. The query may be modified by converting the inspector back to a CommissionQuery.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartFoundries
Description

Tests if this user can manage smart foundries. 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 foundry management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCommissionQuery
Description

Gets a commission query.

Returnosid.resourcing.CommissionQuerythe commission query
CompliancemandatoryThis method must be implemented.
MethodgetCommissionSearchOrder
Description

Gets a commission search order.

Returnosid.resourcing.CommissionSearchOrderthe commission search order
CompliancemandatoryThis method must be implemented.
MethodapplyCommissionQuery
Description

Applies a commission query to this foundry.

Parametersosid.resourcing.CommissionQuerycommissionQuerythe commission query
ErrorsNULL_ARGUMENT commissionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED commissionQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCommissionQuery
Description

Gets a commission query inspector for this foundry.

Returnosid.resourcing.CommissionQueryInspectorthe commission query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCommissionSequencing
Description

Applies a commission search order to this foundry.

Parametersosid.resourcing.CommissionSearchOrdercommissionSearchOrderthe commission search order
ErrorsNULL_ARGUMENT commissionSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED commissionSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommissionQueryFromInspector
Description

Gets a commission query from an inspector.

Parametersosid.resourcing.CommissionQueryInspectorcommissionQueryInspectora commission query inspector
Returnosid.resourcing.CommissionQuerythe commission query
ErrorsNULL_ARGUMENT commissionQueryInspector is null
UNSUPPORTED commissionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.