Interface | osid.control.ActionGroupSmartSystemSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An 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 | getActionGroupQuery | ||
Description |
Gets an action group query. | ||
Return | osid.control.ActionGroupQuery | the action group query | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupSearchOrder | ||
Description |
Gets an action group search order. | ||
Return | osid.control.ActionGroupSearchOrder | the action group search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyActionGroupQuery | ||
Description |
Applies an action group query to this system. | ||
Parameters | osid.control.ActionGroupQuery | actuionGroupQuery | the action group query |
Errors | NULL_ARGUMENT | actuionGroupQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | actuionGroupQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectActionGroupQuery | ||
Description |
Gets an action group query inspector for this system. | ||
Return | osid.control.ActionGroupQueryInspector | the action group query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyActionGroupSequencing | ||
Description |
Applies an action group search order to this system. | ||
Parameters | osid.control.ActionGroupSearchOrder | actionGroupSearchOrder | the action group search order |
Errors | NULL_ARGUMENT | actionGroupSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | actionGroupSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupQueryFromInspector | ||
Description |
Gets an action group query from an inspector. | ||
Parameters | osid.control.ActionGroupQueryInspector | actuionGroupQueryInspector | an action group query inspector |
Return | osid.control.ActionGroupQuery | the action group query | |
Errors | NULL_ARGUMENT | actuionGroupQueryInspector is null | |
UNSUPPORTED | actuionGroupQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |