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

This session provides methods to re-assign Availabilities to Foundry mappings. An Availability may appear in multiple Foundry objects and removing the last reference to an Availability is the equivalent of deleting it. Each Foundry may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Availability to another Foundry is not a copy operation (eg: does not change its Id ).

MethodcanAssignAvailabilities
Description

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

Returnboolean false if availability is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignAvailabilitiesToFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT foundryId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFoundryIds
Description

Gets a list of foundries including and under the given foundry node in which any availability can be assigned.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFoundryIdsForAvailability
Description

Gets a list of foundries including and under the given foundry node in which a specific availability can be assigned.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdavailabilityIdthe Id of the Availability
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or availabilityId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAvailabilityToFoundry
Description

Adds an existing Availability to a Foundry.

Parametersosid.id.IdavailabilityIdthe Id of the Availability
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUND availabilityId or foundryId not found
NULL_ARGUMENT availabilityId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAvailabilityFromFoundry
Description

Removes an Availability from a Foundry.

Parametersosid.id.IdavailabilityIdthe Id of the Availability
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUND availabilityId or foundryId not found
NULL_ARGUMENT availabilityId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.