Interface | osid.control.SettingSystemSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupSettingSystemSettings | ||
Description |
Tests if this user can perform lookups of
setting/system mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up settings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSettingSystemView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySettingSystemView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSettingIdsBySystem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | systemId | Id of the System |
Return | osid.id.IdList | list of related setting Ids | |
Errors | NOT_FOUND | systemId is not found | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsBySystem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | systemId | Id of the System |
Return | osid.control.SettingList | list of related settings | |
Errors | NOT_FOUND | systemId is not found | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingIdsBySystems | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | systemIds | list of system Ids |
Return | osid.id.IdList | list of setting Ids | |
Errors | NULL_ARGUMENT | systemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsBySystems | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | systemIds | list of system Ids |
Return | osid.control.SettingList | list of settings | |
Errors | NULL_ARGUMENT | systemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSystemIdsBySetting | ||
Description |
Gets the | ||
Parameters | osid.id.Id | settingId | Id of a Setting |
Return | osid.id.IdList | list of systems | |
Errors | NOT_FOUND | settingId is not found | |
NULL_ARGUMENT | settingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSystemsBySetting | ||
Description |
Gets the | ||
Parameters | osid.id.Id | settingId | Id of a Setting |
Return | osid.control.SystemList | list of systems | |
Errors | NOT_FOUND | settingId is not found | |
NULL_ARGUMENT | settingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |