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

This session provides methods to apply AvailabilityEnablers to Availabilities. An Availability with multiple AvailabilityEnablers means any positive rule evaluation across the enablers result in an accessible Availability.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignAvailabilityEnablers
Description

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

Adds an existing AvailabilityEnabler to an Availability.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler
osid.id.IdavailabilityIdthe Id of the Availability
ErrorsALREADY_EXISTS availabilityEnablerId is already applied to availabilityId
NOT_FOUND availabilityEnablerId or availabilityId not found
NULL_ARGUMENT availabilityEnablerId or availabilityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAvailabilityEnablerFromAvailability
Description

Removes an AvailabilityEnabler from an Availability.

Parametersosid.id.IdavailabilityEnablerIdthe Id of the AvailabilityEnabler
osid.id.IdavailabilityIdthe Id of the Availability
ErrorsNOT_FOUND availabilityEnablerId or availabilityId not found or availabilityEnablerId not applied to availabilityId
NULL_ARGUMENT availabilityEnablerId or availabilityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceAvailabilityEnablers
Description

Tests if this user can order AvailabilityEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if AvailabilityEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveAvailabilityEnablerAhead
Description

Reorders availability enablers for an availability by moving the specified availability enabler in front of a reference availability enabler.

Parametersosid.id.IdavailabilityEnablerIdthe Id of an AvailabilityEnabler
osid.id.IdavailabilityIdthe Id of an Availability
osid.id.IdreferenceIdthe reference availability enabler Id
ErrorsNOT_FOUND availabilityEnablerId, availabilityId, or referenceId not found or, availabilityEnablerId or referenceId not related to availabilityId
NULL_ARGUMENT availabilityEnablerId, availabilityId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveAvailabilitynEnablerBehind
Description

Reorders availability enablers for an availability by moving the specified availability enabler behind a reference availability enabler.

Parametersosid.id.IdavailabilityEnablerIdthe Id of an AvailabilityEnabler
osid.id.IdavailabilityIdthe Id of an Availability
osid.id.IdreferenceIdthe reference availability enabler Id
ErrorsNOT_FOUND availabilityEnablerId, availabilityId, or referenceId not found or, availabilityEnablerId or referenceId not related to availabilityId
NULL_ARGUMENT availabilityEnablerId, availabilityId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderAvailabilityEnablers
Description

Reorders a set of availability enablers for an availability.

Parametersosid.id.Id[]availabilityEnablerIdsthe Ids for a set of AvailabilityEnablers
osid.id.IdavailabilityIdthe Id of an Availability
ErrorsNOT_FOUND availabilityId not found or, an availabilityEnablerId not related to availabilityId
NULL_ARGUMENT availabilityEnablerIds or availabilityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.