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

This session provides methods for retrieving Foundry objects. The Foundry represents a collection of jobs, work, availabilities, commissions, and efforts.

This session defines views that offer differing behaviors when retrieving multiple objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Foundries it can access, without breaking execution. However, an assessment may only be useful if all Foundries referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupFoundries
Description

Tests if this user can perform Foundry lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeFoundryView
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.
MethodusePlenaryFoundryView
Description

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

Gets the Foundry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Foundry may have a different Id than requested, such as the case where a duplicate Id was assigned to a Foundry and retained for compatibility.

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

Gets a FoundryList corresponding to the given IdList. In plenary mode, the returned list contains all of the foundries specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Foundries may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListfoundryIdsthe list of Ids to retrieve
Returnosid.resourcing.FoundryListthe returned Foundry list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT foundryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByGenusType
Description

Gets a FoundryList corresponding to the given foundry genus Type which does not include foundries of types derived from the specified Type. In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.

Parametersosid.type.TypefoundryGenusTypea foundry genus type
Returnosid.resourcing.FoundryListthe returned Foundry list
ErrorsNULL_ARGUMENT foundryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByParentGenusType
Description

Gets a FoundryList corresponding to the given foundry genus Type and include any additional foundries with genus types derived from the specified Type. In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.

Parametersosid.type.TypefoundryGenusTypea foundry genus type
Returnosid.resourcing.FoundryListthe returned Foundry list
ErrorsNULL_ARGUMENT foundryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByRecordType
Description

Gets a FoundryList containing the given foundry record Type. In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.

Parametersosid.type.TypefoundryRecordTypea foundry record type
Returnosid.resourcing.FoundryListthe returned Foundry list
ErrorsNULL_ARGUMENT foundryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundriesByProvider
Description

Gets a FoundryList from the given provider. In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.resourcing.FoundryListthe returned Foundry list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFoundries
Description

Gets all Foundries. In plenary mode, the returned list contains all known foundries or an error results. Otherwise, the returned list may contain only those foundries that are accessible through this session.

Returnosid.resourcing.FoundryLista list of Foundries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.