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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AvailabilityQuery can be retrieved from this session and foundryped to this Foundry to create a virtual collection of Availabilities. The availabilities may be sequenced using the AvailabilitySearchOrder from this session.

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

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

Gets an availability query.

Returnosid.resourcing.AvailabilityQuerythe availability query
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilitySearchOrder
Description

Gets an availability search order.

Returnosid.resourcing.AvailabilitySearchOrderthe availability search order
CompliancemandatoryThis method must be implemented.
MethodapplyAvailabilityQuery
Description

Applies an availability query to this foundry.

Parametersosid.resourcing.AvailabilityQueryavailabilityQuerythe availability query
ErrorsNULL_ARGUMENT availabilityQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED availabilityQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecAvailabilityQuery
Description

Gets an availability query inspector for this foundry.

Returnosid.resourcing.AvailabilityQueryInspectorthe availability query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAvailabilitySequencing
Description

Applies an availability search order to this foundry.

Parametersosid.resourcing.AvailabilitySearchOrderavailabilitySearchOrderthe availability search order
ErrorsNULL_ARGUMENT availabilitySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED availabilitySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityQueryFromInspector
Description

Gets an availability query from an inspector.

Parametersosid.resourcing.AvailabilityQueryInspectoravailabilityQueryInspectoran availability query inspector
Returnosid.resourcing.AvailabilityQuerythe availability query
ErrorsNULL_ARGUMENT availabilityQueryInspector is null
UNSUPPORTED availabilityQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.