Interface | osid.control.TriggerSmartSystemSession | ||
---|---|---|---|
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 | getTriggerQuery | ||
Description |
Gets a trigger query. | ||
Return | osid.control.TriggerQuery | the trigger query | |
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerSearchOrder | ||
Description |
Gets a trigger search order. | ||
Return | osid.control.TriggerSearchOrder | the trigger search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyTriggerQuery | ||
Description |
Applies a trigger query to this system. | ||
Parameters | osid.control.TriggerQuery | triggerQuery | the trigger query |
Errors | NULL_ARGUMENT | triggerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | triggerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectTriggerQuery | ||
Description |
Gets a trigger query inspector for this system. | ||
Return | osid.control.TriggerQueryInspector | the trigger query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyTriggerSequencing | ||
Description |
Applies a trigger search order to this system. | ||
Parameters | osid.control.TriggerSearchOrder | triggerSearchOrder | the trigger search order |
Errors | NULL_ARGUMENT | triggerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | triggerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerQueryFromInspector | ||
Description |
Gets a trigger query from an inspector. | ||
Parameters | osid.control.TriggerQueryInspector | triggerQueryInspector | a trigger query inspector |
Return | osid.control.TriggerQuery | the trigger query | |
Errors | NULL_ARGUMENT | triggerQueryInspector is null | |
UNSUPPORTED | triggerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |