com.zebra.sdk.settings

Interface SettingsProvider

All Known Subinterfaces:

Device, ZebraPrinterLinkOs

All Known Implementing Classes:

Profile

public interface SettingsProvider

Interface implemented by devices that provide settings. SettingsProviderExample.java

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<String,Setting>	getAllSettings() Retrieve all settings and their attributes.
java.util.Map<String,String>	getAllSettingValues() Retrieves all of the device's setting values.
java.util.Set<String>	getAvailableSettings() Retrieve all of the setting identifiers for a device.
String	getSettingRange(String settingId) Retrieves the allowable range for a setting.
java.util.Map<String,String>	getSettingsValues(java.util.List<String> listOfSettings) Retrieves the device's setting values for a list of setting IDs.
String	getSettingType(String settingId) Returns the data type of the setting.
String	getSettingValue(String settingId) Retrieves the device's setting value for a setting id.
boolean	isSettingReadOnly(String settingId) Returns true if the setting is read only.
boolean	isSettingValid(String settingId, String value) Returns true if value is valid for the given setting.
boolean	isSettingWriteOnly(String settingId) Returns true if the setting is write only.
java.util.Map<String,String>	processSettingsViaMap(java.util.Map<String,String> settingValuePairs) Change or retrieve printer settings.
void	setSetting(String settingId, String value) Sets the setting to the given value.
void	setSettings(java.util.Map<String,String> settingValuePairs) Set more than one setting.

Method Detail

getAvailableSettings

java.util.Set<String> getAvailableSettings()
                                           throws SettingsException

Retrieve all of the setting identifiers for a device. These are the IDs that may be used as keys for retrieving and updating settings for a device.

Returns:

Set of identifiers available for a device.

Throws:

SettingsException - if the settings could not be loaded

See Also:

getSettingValue(String)

getSettingValue

String getSettingValue(String settingId)
                       throws SettingsException,
                              ConnectionException,
                              ZebraIllegalArgumentException

Retrieves the device's setting value for a setting id.

Parameters:

settingId - setting id.

Returns:

the setting's value.

Throws:

SettingsException - if the setting could not be retrieved.

ZebraIllegalArgumentException - if there was an error parsing the response from the printer.

ConnectionException - if there is an error communicating with the printer.

getSettingsValues

java.util.Map<String,String> getSettingsValues(java.util.List<String> listOfSettings)
                                               throws SettingsException,
                                                      ConnectionException,
                                                      ZebraIllegalArgumentException

Retrieves the device's setting values for a list of setting IDs.

Parameters:

listOfSettings - list of setting IDs.

Returns:

the settings' values.

Throws:

SettingsException - if the settings could not be retrieved.

ZebraIllegalArgumentException - if there was an error parsing the response from the printer.

ConnectionException - if there is an error communicating with the printer.

getAllSettings

java.util.Map<String,Setting> getAllSettings()
                                             throws SettingsException

Retrieve all settings and their attributes.

Returns:

Map of setting IDs and setting attributes contained in the profile

Throws:

SettingsException - if the settings could not be retrieved

getAllSettingValues

java.util.Map<String,String> getAllSettingValues()
                                                 throws SettingsException

Retrieves all of the device's setting values.

Returns:

Values of all the settings provided by the device.

Throws:

SettingsException - if the settings could not be loaded

See Also:

getAllSettingValues()

setSetting

void setSetting(String settingId,
              String value)
                throws SettingsException

Sets the setting to the given value.

Parameters:

settingId - setting id.

value - The setting's value

Throws:

SettingsException - if the setting is read only, does not exist, or if the setting could not be set

setSettings

void setSettings(java.util.Map<String,String> settingValuePairs)
                 throws SettingsException

Set more than one setting.

Parameters:

settingValuePairs - Map a setting ID to the new value for the setting.

Throws:

SettingsException - if the settings cannot be sent to the device.

getSettingRange

String getSettingRange(String settingId)
                       throws SettingsException

Retrieves the allowable range for a setting.

Parameters:

settingId - setting id.

Returns:

the setting's range as a string

Throws:

SettingsException - if the setting does not exist

isSettingValid

boolean isSettingValid(String settingId,
                     String value)
                       throws SettingsException

Returns true if value is valid for the given setting.

Parameters:

settingId - setting id.

value - the setting's value

Returns:

true if value is valid for the given setting.

Throws:

SettingsException - if the setting does not exist

isSettingReadOnly

boolean isSettingReadOnly(String settingId)
                          throws SettingsException

Returns true if the setting is read only.

Parameters:

settingId - the setting id

Returns:

true if the setting is read only

Throws:

SettingsException - if the setting does not exist

isSettingWriteOnly

boolean isSettingWriteOnly(String settingId)
                           throws SettingsException

Returns true if the setting is write only.

Parameters:

settingId - the setting id

Returns:

true if the setting is write only

Throws:

SettingsException - if the setting does not exist

getSettingType

String getSettingType(String settingId)
                      throws SettingsException

Returns the data type of the setting.

Parameters:

settingId - the setting id

Returns:

the data type of the setting (e.g. string, bool, enum, etc.)

Throws:

SettingsException - if the setting does not exist

processSettingsViaMap

java.util.Map<String,String> processSettingsViaMap(java.util.Map<String,String> settingValuePairs)
                                                   throws SettingsException,
                                                          ConnectionException

Change or retrieve printer settings.

Note: Due to the setting verification and validation, additional time and data traffic will be needed for each processSettingsViaMap method call. It is recommended to bundle all settings into one map and one method call to reduce this overhead.

Parameters:

settingValuePairs - The settings to change or retrieve

Returns:

Map results of the setting commands

Throws:

SettingsException - if a setting is malformed, or one or more settings could not be set.

ConnectionException - if there is an error communicating with the printer.