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

This session provides methods to retrieve Commission to Foundry mappings. A Commission 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
MethodcanLookupCommissionFoundryMappings
Description

Tests if this user can perform lookups of commission/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.
MethoduseComparativeCommissionFoundryView
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.
MethodusePlenaryCommissionFoundryView
Description

A complete view of the Commission 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.
MethodgetCommissionIdsByFoundry
Description

Gets the list of Commission Ids associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.id.IdListlist of related commission 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.
MethodgetCommissionsByFoundry
Description

Gets the list of Commissions associated with a Foundry.

Parametersosid.id.IdfoundryId Id of the Foundry
Returnosid.resourcing.CommissionListlist of related commissions
ErrorsNOT_FOUND foundryId is not found
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionIdsByFoundries
Description

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

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

Gets the list of Commission corresponding to a list of Foundries.

Parametersosid.id.IdListfoundryIdslist of foundry Ids
Returnosid.resourcing.CommissionListlist of commissions
ErrorsNULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundryIdsByCommission
Description

Gets the Foundry Ids mapped to a Commission.

Parametersosid.id.IdcommissionId Id of a Commission
Returnosid.id.IdListlist of foundries
ErrorsNOT_FOUND commissionId is not found
NULL_ARGUMENT commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByCommission
Description

Gets the Foundries mapped to a Commission.

Parametersosid.id.IdcommissionId Id of a Commission
Returnosid.resourcing.FoundryListlist of foundries
ErrorsNOT_FOUND commissionId is not found
NULL_ARGUMENT commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.