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

This session manages queries and sequencing to create "smart" dynamic foundries. an AvailabilityEnablerQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of availability enablers. The availability enabler may be sequenced using the AvailabilityEnablerSearchOrder from this session.

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

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

Gets an availability enabler query.

Returnosid.resourcing.rules.AvailabilityEnablerQuerythe availability enabler query
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerSearchOrder
Description

Gets an availability enabler search order.

Returnosid.resourcing.rules.AvailabilityEnablerSearchOrderthe availability enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyAvailabilityEnablerQuery
Description

Applies an availability enabler query to this foundry.

Parametersosid.resourcing.rules.AvailabilityEnablerQueryavailabilityEnablerQuerythe availability enabler query
ErrorsNULL_ARGUMENT availabilityEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED availabilityEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAvailabilityEnablerQuery
Description

Gets an availability enabler query inspector for this foundry.

Returnosid.resourcing.rules.AvailabilityEnablerQueryInspectorthe availability enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAvailabilityEnablerSequencing
Description

Applies an availability enabler search order to this foundry.

Parametersosid.resourcing.rules.AvailabilityEnablerSearchOrderavailabilityEnablerSearchOrderthe availability enabler search order
ErrorsNULL_ARGUMENT availabilityEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED availabilityEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerQueryFromInspector
Description

Gets an availability enabler query from an inspector.

Parametersosid.resourcing.rules.AvailabilityEnablerQueryInspectoravailabilityEnablerQueryInspectoran availability enabler query inspector
Returnosid.resourcing.rules.AvailabilityEnablerQuerythe availability enabler query
ErrorsNULL_ARGUMENT availabilityEnablerQueryInspector is null
UNSUPPORTED availabilityEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.