Interface | osid.resourcing.rules.AvailabilityEnablerRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getFoundryId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Foundry Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundry | ||
Description |
Gets the | ||
Return | osid.resourcing.Foundry | the foundry | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignAvailabilityEnablers | ||
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 | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignAvailabilityEnablerToAvailability | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | availabilityEnablerId | the Id of the AvailabilityEnabler |
osid.id.Id | availabilityId | the Id of the Availability | |
Errors | ALREADY_EXISTS | availabilityEnablerId is already applied to
availabilityId | |
NOT_FOUND | availabilityEnablerId or availabilityId not
found | ||
NULL_ARGUMENT | availabilityEnablerId or availabilityId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignAvailabilityEnablerFromAvailability | ||
Description |
Removes an | ||
Parameters | osid.id.Id | availabilityEnablerId | the Id of the AvailabilityEnabler |
osid.id.Id | availabilityId | the Id of the Availability | |
Errors | NOT_FOUND | availabilityEnablerId or availabilityId not
found or availabilityEnablerId not applied to
availabilityId | |
NULL_ARGUMENT | availabilityEnablerId or availabilityId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceAvailabilityEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if AvailabilityEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveAvailabilityEnablerAhead | ||
Description |
Reorders availability enablers for an availability by moving the specified availability enabler in front of a reference availability enabler. | ||
Parameters | osid.id.Id | availabilityEnablerId | the Id of an AvailabilityEnabler |
osid.id.Id | availabilityId | the Id of an Availability | |
osid.id.Id | referenceId | the reference availability enabler Id | |
Errors | NOT_FOUND | availabilityEnablerId, availabilityId, or referenceId
not found or, availabilityEnablerId or
referenceId not related to availabilityId | |
NULL_ARGUMENT | availabilityEnablerId, availabilityId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveAvailabilitynEnablerBehind | ||
Description |
Reorders availability enablers for an availability by moving the specified availability enabler behind a reference availability enabler. | ||
Parameters | osid.id.Id | availabilityEnablerId | the Id of an AvailabilityEnabler |
osid.id.Id | availabilityId | the Id of an Availability | |
osid.id.Id | referenceId | the reference availability enabler Id | |
Errors | NOT_FOUND | availabilityEnablerId, availabilityId, or referenceId
not found or, availabilityEnablerId or
referenceId not related to availabilityId | |
NULL_ARGUMENT | availabilityEnablerId, availabilityId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderAvailabilityEnablers | ||
Description |
Reorders a set of availability enablers for an availability. | ||
Parameters | osid.id.Id[] | availabilityEnablerIds | the Ids for a set of AvailabilityEnablers |
osid.id.Id | availabilityId | the Id of an Availability | |
Errors | NOT_FOUND | availabilityId not found or, an availabilityEnablerId
not related to availabilityId | |
NULL_ARGUMENT | availabilityEnablerIds or availabilityId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |