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

This session manages queries and sequencing to create "smart" dynamic catalogs. A WorkQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of Works. The works may be sequenced using the WorkSearchOrder from this session.

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

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

Gets a work query.

Returnosid.resourcing.WorkQuerythe work query
CompliancemandatoryThis method must be implemented.
MethodgetWorkSearchOrder
Description

Gets a work search order.

Returnosid.resourcing.WorkSearchOrderthe work search order
CompliancemandatoryThis method must be implemented.
MethodapplyWorkQuery
Description

Applies a work query to this foundry.

Parametersosid.resourcing.WorkQueryworkQuerythe work query
ErrorsNULL_ARGUMENT workQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED workQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectWorkQuery
Description

Gets a work query inspector for this foundry.

Returnosid.resourcing.WorkQueryInspectorthe work query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyWorkSequencing
Description

Applies a work search order to this foundry.

Parametersosid.resourcing.WorkSearchOrderworkSearchOrderthe work search order
ErrorsNULL_ARGUMENT workSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED workSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetWorkQueryFromInspector
Description

Gets a work query from an inspector.

Parametersosid.resourcing.WorkQueryInspectorworkQueryInspectora work query inspector
Returnosid.resourcing.WorkQuerythe work query
ErrorsNULL_ARGUMENT workQueryInspector is null
UNSUPPORTED workQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.