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

This session provides methods to re-assign AvailabilityEnabler to Foundry mappings. an AvailabilityEnabler may appear in multiple Foundry objects and removing the last reference to an AvailabilityEnabler 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 AvailabilityEnabler to another Foundry is not a copy operation (eg: does not change its Id ).

MethodcanAssignAvailabilityEnablers
Description

Tests if this user can alter availability enabler/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 lookup operations to unauthorized users.

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

Tests if this user can alter availability enabler/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 lookup 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 enabler 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.
MethodgetAssignableFoundryIdsForAvailabilityEnabler
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or availabilityEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAvailabilityEnablerToFoundry
Description

Adds an existing AvailabilityEnabler to a Foundry.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsALREADY_EXISTS availabilityEnablerId is already assigned to foundryId
NOT_FOUND availabilityEnablerId or foundryId not found
NULL_ARGUMENT availabilityEnablerId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAvailabilityEnablerFromFoundry
Description

Removes an AvailabilityEnabler from a Foundry.

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