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

This session provides methods to retrieve AvailabilityEnabler to Foundry mappings. an AvailabilityEnabler may appear in multiple Foundry objects. Each foundry may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupAvailabilityEnablerFoundryMappings
Description

Tests if this user can perform lookups of availability enabler/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAvailabilityEnablerFoundryView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAvailabilityEnablerFoundryView
Description

A complete view of the AvailabilityEnabler and Foundry returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetAvailabilityEnablerIdsByFoundry
Description

Gets the list of AvailabilityEnablerIds associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.id.IdListlist of related availability enabler Ids
ErrorsNOT_FOUND foundryId is not found
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablersByFoundry
Description

Gets the list of availability enabler associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.resourcing.rules.AvailabilityEnablerListlist of related availability enablers
ErrorsNOT_FOUND foundryId is not found
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablerIdsByFoundries
Description

Gets the list of AvailabilityEnabler Ids corresponding to a list of Foundries.

Parametersosid.id.IdListfoundryIdslist of foundry Ids
Returnosid.id.IdListlist of availability enabler Ids
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAvailabilityEnablersByFoundries
Description

Gets the list of availability enabler corresponding to a list of Foundries.

Parametersosid.id.IdListfoundryIdslist of foundry Ids
Returnosid.resourcing.rules.AvailabilityEnablerListlist of availability enablers
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundryIdsByAvailabilityEnabler
Description

Gets the Foundry Ids mapped to an AvailabilityEnabler.

Parametersosid.id.IdavailabilityEnablerId Id of an AvailabilityEnabler
Returnosid.id.IdListlist of foundries
ErrorsNOT_FOUND availabilityEnablerId is not found
NULL_ARGUMENT availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundrysByAvailabilityEnabler
Description

Gets the Foundries mapped to an AvailabilityEnabler.

Parametersosid.id.IdavailabilityEnablerId Id of an AvailabilityEnabler
Returnosid.resourcing.FoundryListlist of foundries
ErrorsNOT_FOUND availabilityEnablerId is not found
NULL_ARGUMENT availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.