Interface | osid.resourcing.CommissionSmartFoundrySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A 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 | getCommissionQuery | ||
Description |
Gets a commission query. | ||
Return | osid.resourcing.CommissionQuery | the commission query | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionSearchOrder | ||
Description |
Gets a commission search order. | ||
Return | osid.resourcing.CommissionSearchOrder | the commission search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyCommissionQuery | ||
Description |
Applies a commission query to this foundry. | ||
Parameters | osid.resourcing.CommissionQuery | commissionQuery | the commission query |
Errors | NULL_ARGUMENT | commissionQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | commissionQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectCommissionQuery | ||
Description |
Gets a commission query inspector for this foundry. | ||
Return | osid.resourcing.CommissionQueryInspector | the commission query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyCommissionSequencing | ||
Description |
Applies a commission search order to this foundry. | ||
Parameters | osid.resourcing.CommissionSearchOrder | commissionSearchOrder | the commission search order |
Errors | NULL_ARGUMENT | commissionSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | commissionSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionQueryFromInspector | ||
Description |
Gets a commission query from an inspector. | ||
Parameters | osid.resourcing.CommissionQueryInspector | commissionQueryInspector | a commission query inspector |
Return | osid.resourcing.CommissionQuery | the commission query | |
Errors | NULL_ARGUMENT | commissionQueryInspector is null | |
UNSUPPORTED | commissionQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |