Interface | osid.resourcing.rules.AvailabilityEnablerSmartFoundrySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic foundries. an This | ||
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 | canManageSmartFoundries | ||
Description |
Tests if this user can manage smart foundries. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart foundry management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilityEnablerQuery | ||
Description |
Gets an availability enabler query. | ||
Return | osid.resourcing.rules.AvailabilityEnablerQuery | the availability enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilityEnablerSearchOrder | ||
Description |
Gets an availability enabler search order. | ||
Return | osid.resourcing.rules.AvailabilityEnablerSearchOrder | the availability enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyAvailabilityEnablerQuery | ||
Description |
Applies an availability enabler query to this foundry. | ||
Parameters | osid.resourcing.rules.AvailabilityEnablerQuery | availabilityEnablerQuery | the availability enabler query |
Errors | NULL_ARGUMENT | availabilityEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | availabilityEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectAvailabilityEnablerQuery | ||
Description |
Gets an availability enabler query inspector for this foundry. | ||
Return | osid.resourcing.rules.AvailabilityEnablerQueryInspector | the availability enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyAvailabilityEnablerSequencing | ||
Description |
Applies an availability enabler search order to this foundry. | ||
Parameters | osid.resourcing.rules.AvailabilityEnablerSearchOrder | availabilityEnablerSearchOrder | the availability enabler search order |
Errors | NULL_ARGUMENT | availabilityEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | availabilityEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilityEnablerQueryFromInspector | ||
Description |
Gets an availability enabler query from an inspector. | ||
Parameters | osid.resourcing.rules.AvailabilityEnablerQueryInspector | availabilityEnablerQueryInspector | an availability enabler query inspector |
Return | osid.resourcing.rules.AvailabilityEnablerQuery | the availability enabler query | |
Errors | NULL_ARGUMENT | availabilityEnablerQueryInspector is null | |
UNSUPPORTED | availabilityEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |