Interface | osid.control.InputSmartSystemSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartSystems | ||
Description |
Tests if this user can manage smart systems. 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 system management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputQuery | ||
Description |
Gets an input query. | ||
Return | osid.control.InputQuery | the input query | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputSearchOrder | ||
Description |
Gets an input search order. | ||
Return | osid.control.InputSearchOrder | the input search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyInputQuery | ||
Description |
Applies an input query to this system. | ||
Parameters | osid.control.InputQuery | inputQuery | the input query |
Errors | NULL_ARGUMENT | inputQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | inputQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectInputQuery | ||
Description |
Gets an input query inspector for this system. | ||
Return | osid.control.InputQueryInspector | the input query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyInputSequencing | ||
Description |
Applies an input search order to this system. | ||
Parameters | osid.control.InputSearchOrder | inputSearchOrder | the input search order |
Errors | NULL_ARGUMENT | inputSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | inputSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputQueryFromInspector | ||
Description |
Gets an input query from an inspector. | ||
Parameters | osid.control.InputQueryInspector | inputQueryInspector | an input query inspector |
Return | osid.control.InputQuery | the input query | |
Errors | NULL_ARGUMENT | inputQueryInspector is null | |
UNSUPPORTED | inputQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |