com.zebra.sdk.common.card.job

Interface JobControlProvider

All Known Subinterfaces:

ZebraCardPrinter, ZebraPrinterZmotif, ZebraPrinterZxp

public interface JobControlProvider

Interface implemented by jobControl that provides access to job related settings.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<String,Setting>	getAllJobSettings() Retrieve all settings and their attributes.
java.util.Map<String,String>	getAllJobSettingValues() Retrieves all of the printer's setting values.
String	getJobSettingRange(String settingId) Retrieves the allowable range for a setting.
java.util.Set<String>	getJobSettings() Retrieve all of the setting identifiers for a printer.
java.util.Map<String,String>	getJobSettingsValues(java.util.List<String> listOfSettings) Retrieves the printer's setting values for a list of setting IDs.
String	getJobSettingType(String settingId) Returns the data type of the setting.
String	getJobSettingValue(String settingId) Retrieves the printer's setting value for a specific setting ID.
boolean	isJobSettingReadOnly(String settingId) Returns true if the setting's value is read only for the given setting.
boolean	isJobSettingValid(String settingId, String value) Returns true if the setting's value is valid for the given setting.
boolean	isJobSettingWriteOnly(String settingId) Returns true if the setting's value is write only for the given setting.
void	setJobSetting(String settingId, String value) Sets the printer's setting to the given value.
void	setJobSettings(java.util.Map<String,String> settingValuePairs) Sets a set of the printer's settings to their given values.

Method Detail

getJobSettings

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

Retrieve all of the setting identifiers for a printer.

• Note These are the IDs that may be used as keys for retrieving and updating settings for a device.

Returns:

a Set of identifiers available for a device.

Throws:

SettingsException - if the setting IDs could not be loaded.

getJobSettingValue

String getJobSettingValue(String settingId)
                          throws SettingsException

Retrieves the printer's setting value for a specific setting ID.

Parameters:

settingId - the setting ID for the setting you want to retrieve.

Returns:

the setting's value.

Throws:

SettingsException - if the setting could not be retrieved or there is an error communicating with the printer.

getJobSettingsValues

java.util.Map<String,String> getJobSettingsValues(java.util.List<String> listOfSettings)
                                                  throws SettingsException

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

Parameters:

listOfSettings - a list of setting IDs for the settings you want to retrieve.

Returns:

a Map containing the setting IDs their values.

• Key = The setting ID.
• Value = The setting value.

Throws:

SettingsException - if the settings could not be retrieved or there is an error communicating with the printer.

getAllJobSettingValues

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

Retrieves all of the printer's setting values.

Returns:

a Map containing the printer's IDs and values of all the settings provided by the printer.

• Key = The setting ID.
• Value = The setting value.

Throws:

SettingsException - if the settings could not be retrieved or there is an error communicating with the printer.

getAllJobSettings

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

Retrieve all settings and their attributes.

Returns:

a Map of job setting IDs and setting attributes contained in the profile.

Throws:

SettingsException - if the settings could not be retrieved.

setJobSetting

void setJobSetting(String settingId,
                 String value)
                   throws SettingsException

Sets the printer's setting to the given value.

Parameters:

settingId - the setting id of the setting you wish to update.

value - the setting's value.

Throws:

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

setJobSettings

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

Sets a set of the printer's settings to their given values.

Parameters:

settingValuePairs - a Map containing the setting's ID and the new value for the setting.

• Key = The setting ID.
• Value = The setting value.

Throws:

SettingsException - if any of the settings are read only, do not exist, or could not be set.

getJobSettingRange

String getJobSettingRange(String settingId)
                          throws SettingsException

Retrieves the allowable range for a setting.

Parameters:

settingId - the setting id for the setting you wish to retrieve the range for.

Returns:

the setting's range as a string.

Throws:

SettingsException - if the setting does not exist or the setting's range could not be retrieved.

isJobSettingValid

boolean isJobSettingValid(String settingId,
                        String value)
                          throws SettingsException

Returns true if the setting's value is valid for the given setting.

Parameters:

settingId - the setting id of the setting you wish to validate.

value - the setting's value.

Returns:

true if value is valid for the given setting.

Throws:

SettingsException - if the setting does not exist.

isJobSettingReadOnly

boolean isJobSettingReadOnly(String settingId)
                             throws SettingsException

Returns true if the setting's value is read only for the given setting.

Parameters:

settingId - the setting id of the setting you wish to validate.

Returns:

true if the setting is read only.

Throws:

SettingsException - if the setting does not exist.

isJobSettingWriteOnly

boolean isJobSettingWriteOnly(String settingId)
                              throws SettingsException

Returns true if the setting's value is write only for the given setting.

Parameters:

settingId - the setting id of the setting you wish to validate.

Returns:

true if the setting is write only.

Throws:

SettingsException - if the setting does not exist.

getJobSettingType

String getJobSettingType(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.