OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Interfaceosid.resourcing.rules.AvailabilityEnablerFoundryAssignmentSession
Implementsosid.OsidSession
Used Byosid.resourcing.rules.ResourcingRulesManager
osid.resourcing.rules.ResourcingRulesProxyManager
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.

Returnbooleanfalse 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
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTfoundryId 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_ARGUMENTfoundryId 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_ARGUMENTfoundryId 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_EXISTSavailabilityEnablerId is already assigned to foundryId
NOT_FOUNDavailabilityEnablerId or foundryId not found
NULL_ARGUMENTavailabilityEnablerId 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_FOUNDavailabilityEnablerId or foundryId not found or availabilityEnablerId not assigned to foundryId
NULL_ARGUMENTavailabilityEnablerId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAvailabilityEnablerToFoundry
Description

Moves an AvailabilityEnabler from one Foundry to another. Mappings to other Foundries are unaffected.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler
osid.id.IdfromFoundryIdthe Id of the current Foundry
osid.id.IdtoFoundryIdthe Id of the destination Foundry
ErrorsALREADY_EXISTSavailabilityEnablerId already assigned to toFoundryId
NOT_FOUNDavailabilityEnablerId, fromFoundryId , or toFoundryId not found or availabilityEnablerId not mapped to fromFoundryId
NULL_ARGUMENTavailabilityEnablerId, fromFoundryId , or toFoundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.