Interface | osid.control.SettingLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving settings. This lookup session defines several views:
The methods Settings may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the settings. | ||
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 | canLookupSettings | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSettingView | ||
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 | usePlenarySettingView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedSystemView | ||
Description |
Federates the view for methods in this session. A federated view will include settings in systems which are children of this system in the system hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedSystemView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this system only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSetting | ||
Description |
Gets the | ||
Parameters | osid.id.Id | settingId | the Id of the Setting to retrieve |
Return | osid.control.Setting | the returned Setting | |
Errors | NOT_FOUND | no Setting found with the given Id | |
NULL_ARGUMENT | settingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | settingIds | the list of Ids to retrieve |
Return | osid.control.SettingList | the returned Setting list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | settingIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | settingGenusType | a setting genus type |
Return | osid.control.SettingList | the returned Setting list | |
Errors | NULL_ARGUMENT | settingGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | settingGenusType | a setting genus type |
Return | osid.control.SettingList | the returned Setting list | |
Errors | NULL_ARGUMENT | settingGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known settings or an error results. Otherwise, the returned list may contain only those settings that are accessible through this session. | ||
Parameters | osid.type.Type | settingRecordType | a setting record type |
Return | osid.control.SettingList | the returned Setting list | |
Errors | NULL_ARGUMENT | settingRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsForController | ||
Description |
Gets a list of settings for a controller. | ||
Parameters | osid.id.Id | controllerId | a controller Id |
Return | osid.control.SettingList | the returned Setting list | |
Errors | NULL_ARGUMENT | controllerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettings | ||
Description |
Gets all settings. | ||
Return | osid.control.SettingList | the returned Setting list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |