Interface | osid.resourcing.EffortSmartFoundrySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. 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 | getEffortQuery | ||
Description |
Gets an effort query. | ||
Return | osid.resourcing.EffortQuery | the effort query | |
Compliance | mandatory | This method must be implemented. | |
Method | getEffortSearchOrder | ||
Description |
Gets an effort search order. | ||
Return | osid.resourcing.EffortSearchOrder | the effort search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyEffortQuery | ||
Description |
Applies an effort query to this foundry. | ||
Parameters | osid.resourcing.EffortQuery | effortQuery | the effort query |
Errors | NULL_ARGUMENT | effortQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | effortQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectEffortQuery | ||
Description |
Gets an effort query inspector for this foundry. | ||
Return | osid.resourcing.EffortQueryInspector | the effort query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyEffortSequencing | ||
Description |
Applies an effort search order to this foundry. | ||
Parameters | osid.resourcing.EffortSearchOrder | effortSearchOrder | the effort search order |
Errors | NULL_ARGUMENT | effortSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | effortSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEffortQueryFromInspector | ||
Description |
Gets an effort query from an inspector. | ||
Parameters | osid.resourcing.EffortQueryInspector | effortQueryInspector | an effort query inspector |
Return | osid.resourcing.EffortQuery | the effort query | |
Errors | NULL_ARGUMENT | effortQueryInspector is null | |
UNSUPPORTED | effortQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |