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

This session manages queries and sequencing to create "smart" dynamic catalogs. An EffortQuery can be retrieved from this session and foundryped to this Foundry to create a virtual collection of Efforts. The efforts may be sequenced using the EffortSearchOrder from this session.

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

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

Gets an effort query.

Returnosid.resourcing.EffortQuerythe effort query
CompliancemandatoryThis method must be implemented.
MethodgetEffortSearchOrder
Description

Gets an effort search order.

Returnosid.resourcing.EffortSearchOrderthe effort search order
CompliancemandatoryThis method must be implemented.
MethodapplyEffortQuery
Description

Applies an effort query to this foundry.

Parametersosid.resourcing.EffortQueryeffortQuerythe effort query
ErrorsNULL_ARGUMENT effortQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED effortQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectEffortQuery
Description

Gets an effort query inspector for this foundry.

Returnosid.resourcing.EffortQueryInspectorthe effort query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyEffortSequencing
Description

Applies an effort search order to this foundry.

Parametersosid.resourcing.EffortSearchOrdereffortSearchOrderthe effort search order
ErrorsNULL_ARGUMENT effortSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED effortSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEffortQueryFromInspector
Description

Gets an effort query from an inspector.

Parametersosid.resourcing.EffortQueryInspectoreffortQueryInspectoran effort query inspector
Returnosid.resourcing.EffortQuerythe effort query
ErrorsNULL_ARGUMENT effortQueryInspector is null
UNSUPPORTED effortQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.