public interface JobControlHelperUtilZmotif
| Modifier and Type | Method and Description | 
|---|---|
| void | encryptGraphicsData(boolean encryptData)Indicates whether the job's graphics data should be encrypted using the key provided by  setEncryptionKey(byte[]).Encryption option must be pre-configured on the printer. | 
| void | encryptJobControlData(boolean encryptData)Indicates whether the job control data should be encrypted using the key provided by  setEncryptionKey(byte[]).Encryption option must be pre-configured on the printer. | 
| CardDestination | getCardDestination()Returns the current card destination location. | 
| CardSource | getCardSource()Returns the current card source location. | 
| int | getCardThickness()Returns the card thickness in mils. | 
| String | getCardType()Returns the currently selected card type. | 
| int | getColorPreheatLevel()Returns the preheat level for the color panels. | 
| java.util.EnumSet<DataSource> | getDataSource()Returns the selected data source(s) to be used during a read job. | 
| OrientationType | getImageOrientation(CardSide side)Returns the selected image orientation for the specified card side. | 
| ImageRotation | getImageRotation(CardSide side)Returns the image rotation data for the specified card side. | 
| SharpeningLevel | getImageSharpening(CardSide side)Returns the image sharpening level to be used on the specified side of the card. | 
| KOptimizationType | getKPanelOptimization(CardSide side)Returns the selected monochrome panel optimization type for the specified card side. | 
| int | getKPreheatLevel(CardSide side)Returns the current monochrome preheat level. | 
| java.util.Map<TrackNumber,Integer> | getMagBitsPerCharacter()Gets the bits per character for each track number. | 
| CoercivityType | getMagCoercivity()Returns the current coercivity type for magnetic encoding. | 
| java.util.Map<TrackNumber,DataFormat> | getMagDataFormat()Returns the magnetic encoding data format for each track. | 
| java.util.Map<TrackNumber,DataCharParity> | getMagDataParity()Gets the data parity for each track. | 
| CardSide | getMagEncodeSide()Returns the side of the card that will be magnetic encoded. | 
| MagEncodingType | getMagEncodingType()Returns the current type of magnetic encoding to perform. | 
| java.util.Map<TrackNumber,MagSentinel> | getMagSentinelFormat()Gets the sentinel format values for each track. | 
| java.util.Map<TrackNumber,Integer> | getMagTrackDensity()Gets the density value for each track. | 
| PrintOptimizationMode | getPrintOptimizationMode()Gets the print optimization mode. | 
| boolean | isDeleteAfter()Returns whether the image data will be deleted following a completed job. | 
| boolean | isEnableOCPReprint()Returns whether the OCP reprint button in enabled. | 
| boolean | isKPanelOverwrite(CardSide side)Returns whether or not monochrome panel overwrite has been selected for the specified card side. | 
| boolean | isMagVerification()Returns whether magnetic encoding write verification should be performed. | 
| void | setCardDestination(CardDestination destination)Sets the card destination for the current job. | 
| void | setCardSource(CardSource cardSource)Sets the card source for the current job. | 
| void | setCardThickness(int mils)Sets the thickness of the card to be used. | 
| void | setCardType(String cardType)Sets the card type to be used for the job. | 
| void | setColorPreheatLevel(int preheatLevel)Sets the color preheat level. | 
| void | setDataSource(java.util.EnumSet<DataSource> dataSource)Sets the data source(s) to be used during a read job. | 
| void | setDeleteAfter(boolean deleteAfter)Sets the flag indicating whether image data should be deleted following the current job completion. | 
| void | setEnableOCPReprint(boolean enable)Sets whether or not the OCP Reprint button will be enabled. | 
| void | setEncryptionKey(byte[] encryptionKey)Sets the 16 byte encryption used to encrypt job data between the printer and host. Encryption option must be pre-configured on the printer. | 
| void | setHostAuthenticationKey(byte[] authenticationKey)Sets the 16 byte host authentication key used when sending a job to the printer. Host authentication option must be pre-configured on the printer. | 
| void | setImageOrientation(CardSide side,
                   OrientationType orientation)Sets the image orientation for the specified card side for the current job. | 
| void | setImageRotation(CardSide side,
                ImageRotation rotation)Sets the image rotation type for the specified card side for the current job. | 
| void | setImageSharpening(CardSide side,
                  SharpeningLevel sharpness)Sets the image sharpening level to be used on the specified card side. | 
| void | setJobConfiguration(JobConfigInfo jobConfig)Method for configuring the current print job. | 
| void | setKPanelOptimization(CardSide side,
                     KOptimizationType mode)Sets the monochrome optimization mode for the specified card side. | 
| void | setKPanelOverwrite(CardSide side,
                  boolean enable)Sets a flag indicating whether the monochrome panel overwrite should be performed for the specified card side. | 
| void | setKPreheatLevel(CardSide side,
                int level)Sets the monochrome preheat level for the specified card side. | 
| void | setMagBitsPerCharacter(java.util.Map<TrackNumber,Integer> bitsPerChar)Sets the bits per character for each track. | 
| void | setMagCoercivity(CoercivityType coercivity)Sets the magnetic encoding coercivity type for the current job. | 
| void | setMagConfiguration(MagConfigInfo magConfig)Method for configuring settings for a magnetic encoding job. | 
| void | setMagDataFormat(java.util.Map<TrackNumber,DataFormat> dataFormat)Sets the magnetic encoding data format for each track contained in the supplied Map. | 
| void | setMagDataParity(java.util.Map<TrackNumber,DataCharParity> parity)Sets the data character parity for each track for the current job. | 
| void | setMagEncodeSide(CardSide side)Sets the side of card to be magnetic encoded. | 
| void | setMagEncodingType(MagEncodingType type)Sets the type of magnetic encoding to perform for the current job. | 
| void | setMagEncodingType(java.util.Map<TrackNumber,MagEncodingType> type)Sets the magnetic encoding type for each track contained in the specified Map object. | 
| void | setMagSentinelFormat(java.util.Map<TrackNumber,MagSentinel> sentinel)Sets the sentinel formats for each supplied track for the current job. | 
| void | setMagTrackDensity(java.util.Map<TrackNumber,Integer> density)Sets the density value for each supplied track number for the current job. | 
| void | setMagVerification(boolean enabled)Sets whether magnetic encoding write verification should be performed for the current job. | 
| void | setPrintOptimizationMode(PrintOptimizationMode optimizationMode)Sets the print optimization mode. | 
| void | setSmartCardConfiguration(java.util.List<SmartCardType> smartCardTypes)Deprecated. 
 | 
| void | setSmartCardConfigurations(java.util.List<String> smartCardTypes)Configures smart card encoding for the current job. | 
void setHostAuthenticationKey(byte[] authenticationKey)
                              throws SettingsException
authenticationKey - the 16 byte authentication key.SettingsException - if the authentication key is invalid.void setEncryptionKey(byte[] encryptionKey)
                      throws SettingsException
encryptionKey - the 16 byte encryptionKey key.SettingsException - if the encryptionKey key is invalid.void encryptJobControlData(boolean encryptData)
setEncryptionKey(byte[]).encryptData - true to encrypt the job control data.void encryptGraphicsData(boolean encryptData)
setEncryptionKey(byte[]).encryptData - true to encrypt the job's graphics data.int getCardThickness()
                     throws SettingsException
SettingsException - if the setting does not exist, the device is busy, or there is an error communicating with the printer.String getCardType()
                   throws SettingsException,
                          ConnectionException,
                          ZebraCardException
ConnectionException - if the device is busy or there is an error communicating with the printer.SettingsException - if an error occurs while retrieving the card type.ZebraCardException - if a printer error occurs.int getColorPreheatLevel()
                         throws SettingsException
SettingsException - if there was an error parsing the response from the printer or there is an error communicating with the printer.SharpeningLevel getImageSharpening(CardSide side) throws SettingsException
side - side of card.SettingsException - if there was an error parsing the response from the printer or there is an error communicating with the printer.KOptimizationType getKPanelOptimization(CardSide side) throws SettingsException
side - side of card.SettingsException - if there was an error parsing the response from the printer or there is an error communicating with the printer.int getKPreheatLevel(CardSide side) throws SettingsException
side - side of card.SettingsException - if there was an error parsing the response from the printer or there is an error communicating with the printer.java.util.Map<TrackNumber,DataFormat> getMagDataFormat() throws SettingsException
DataFormat.
         SettingsException - if the magnetic encoder does not exist.CardSide getMagEncodeSide() throws SettingsException
SettingsException - if an error occurs while retrieving the card side that will be encoded.boolean isEnableOCPReprint()
                           throws SettingsException
SettingsException - if an error occurs while retrieving the OCP reprint button value.boolean isKPanelOverwrite(CardSide side) throws SettingsException
side - side of card.SettingsException - if the setting could not be retrieved.void setPrintOptimizationMode(PrintOptimizationMode optimizationMode) throws SettingsException
optimizationMode - the print optimization mode for ZMotif Series 9 model printers.SettingsException - if the setting does not exist, the device is busy, or there is an error communicating with the printer.void setCardThickness(int mils)
                      throws SettingsException
mils - card thickness in mils.SettingsException - if the setting does not exist, the device is busy, or there is an error communicating with the printer.void setCardType(String cardType)
                 throws SettingsException,
                        ConnectionException,
                        ZebraCardException
cardType - the card type.ConnectionException - if the device is busy or there is an error communicating with the printer.SettingsException - if an error occurs retrieving the card type.ZebraCardException - if a printer error occurs.void setColorPreheatLevel(int preheatLevel)
                          throws SettingsException
preheatLevel - color preheat level.SettingsException - if the setting does not exist, the device is busy, or there is an error communicating with the printer.void setEnableOCPReprint(boolean enable)
                         throws SettingsException
enable - true to enable.SettingsException - if the setting does not exist, the device is busy, or there is an error communicating with the printer.void setImageSharpening(CardSide side, SharpeningLevel sharpness) throws SettingsException
side - side of card.sharpness - the level of sharpening to apply to the image data.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setKPanelOptimization(CardSide side, KOptimizationType mode) throws SettingsException
side - side of card.mode - monochrome optimization mode.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setKPanelOverwrite(CardSide side, boolean enable) throws SettingsException
side - side of card.enable - true to enable monochrome panel overwrite.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setKPreheatLevel(CardSide side, int level) throws SettingsException
side - side of card.level - monochrome preheat level.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setMagConfiguration(MagConfigInfo magConfig) throws SettingsException, ConnectionException, ZebraCardException, ZebraIllegalArgumentException
magConfig - instance containing details of the magnetic encoding job to perform.ConnectionException - if the device is busy or there is an error communicating with the printer.SettingsException - if an error occurs retrieving the magnetic configuration.ZebraCardException - if a printer error occurs.ZebraIllegalArgumentException - if the magConfig is invalid.void setMagDataFormat(java.util.Map<TrackNumber,DataFormat> dataFormat) throws SettingsException, ZebraIllegalArgumentException
dataFormat - Map containing an entry for each track with the desired DataFormat.
            SettingsException - if an error occurs while retrieving the magnetic encoding data.ZebraIllegalArgumentException - if a printer error occurs.void setMagEncodeSide(CardSide side) throws SettingsException
side - side of card.SettingsException - if an error occurs while setting the card side for magnetic encoding.CardDestination getCardDestination() throws SettingsException
SettingsException - if an error occurs while retrieving the card destination.CardSource getCardSource() throws SettingsException
SettingsException - if an error occurs while retrieving the card source.java.util.EnumSet<DataSource> getDataSource() throws SettingsException
SettingsException - if an error occurs while retrieving the data source.OrientationType getImageOrientation(CardSide side) throws SettingsException
side - side of card.SettingsException - if an error occurs while retrieving the image orientation.ImageRotation getImageRotation(CardSide side) throws SettingsException
side - side of card.SettingsException - if an error occurs while retrieving the image rotation.MagEncodingType getMagEncodingType() throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic encoding type.CoercivityType getMagCoercivity() throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic coercivity type.boolean isDeleteAfter()
                      throws SettingsException
SettingsException - if the setting could not be retrieved.boolean isMagVerification()
                          throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic verification.void setCardDestination(CardDestination destination) throws SettingsException
destination - the card destination location.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setCardSource(CardSource cardSource) throws SettingsException
cardSource - the card source location.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setDataSource(java.util.EnumSet<DataSource> dataSource) throws SettingsException
dataSource - EnumSet of data source(s) for the specified magnetic read operation.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setDeleteAfter(boolean deleteAfter)
                    throws SettingsException
deleteAfter - true to delete image data.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setImageOrientation(CardSide side, OrientationType orientation) throws SettingsException
side - side of card.orientation - the orientation of the image.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setImageRotation(CardSide side, ImageRotation rotation) throws SettingsException
side - side of card.rotation - the rotation of the image data.SettingsException - if the setting is read only, does not exist, or if the setting could not be set.void setJobConfiguration(JobConfigInfo jobConfig) throws SettingsException, ConnectionException, ZebraCardException, ZebraIllegalArgumentException
jobConfig - instance containing details of the job to be printed.ConnectionException - if the device is busy or there is an error communicating with the printer.SettingsException - if an error occurs while setting the job configuration.ZebraCardException - if a printer error occurs.ZebraIllegalArgumentException - if the jobConfig is invalid.void setMagCoercivity(CoercivityType coercivity) throws SettingsException
coercivity - the coercivity type for magnetic encoding.SettingsException - if an error occurs while setting the coercivity type.void setMagEncodingType(MagEncodingType type) throws SettingsException
type - the type of magnetic encoding to perform.SettingsException - if an error occurs while setting the magnetic encoding type.void setMagEncodingType(java.util.Map<TrackNumber,MagEncodingType> type) throws SettingsException, ZebraIllegalArgumentException
type - Map object containing an entry for each track with the desired MagEncodingType.
            SettingsException - if an error occurs while setting the magnetic encoding type.ZebraIllegalArgumentException - if the smartCardTypes is invalid.void setMagVerification(boolean enabled)
                        throws SettingsException
enabled - true to verify the magnetic encoding.SettingsException - if an error occurs while setting the magnetic verification.@Deprecated void setSmartCardConfiguration(java.util.List<SmartCardType> smartCardTypes) throws SettingsException, ZebraIllegalArgumentException
setSmartCardConfigurations(List)smartCardTypes - list of smartcard types for configuring a smart card encoding job.SettingsException - if an error occurs while setting the smart card configuration.ZebraIllegalArgumentException - if the printer model is invalid or if smartCardTypes is invalid.void setSmartCardConfigurations(java.util.List<String> smartCardTypes)
                                throws SettingsException,
                                       ZebraIllegalArgumentException
smartCardTypes - list of smartcard types for configuring a smart card encoding job.SettingsException - if an error occurs while setting the smart card configuration.ZebraIllegalArgumentException - if the smartCardTypes is invalid.java.util.Map<TrackNumber,Integer> getMagTrackDensity() throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic track density.void setMagTrackDensity(java.util.Map<TrackNumber,Integer> density) throws SettingsException, ZebraIllegalArgumentException
density - Map instance containing the density value for each TrackNumber.
            SettingsException - if an error occurs while setting the magnetic track density.ZebraIllegalArgumentException - if the density map is invalid.java.util.Map<TrackNumber,MagSentinel> getMagSentinelFormat() throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic sentinel format.void setMagSentinelFormat(java.util.Map<TrackNumber,MagSentinel> sentinel) throws SettingsException, ZebraIllegalArgumentException
sentinel - Map containing the MagSentinel information for each TrackNumber.
            SettingsException - if an error occurs while setting the magnetic sentinel format.ZebraIllegalArgumentException - if the sentinel map is invalid.java.util.Map<TrackNumber,Integer> getMagBitsPerCharacter() throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic bits per character.void setMagBitsPerCharacter(java.util.Map<TrackNumber,Integer> bitsPerChar) throws SettingsException, ZebraIllegalArgumentException
bitsPerChar - Map instance containing the bits per character for each TrackNumber.
            SettingsException - if an error occurs while setting the magnetic bits per character.ZebraIllegalArgumentException - if the bitsPerChar map is invalid.java.util.Map<TrackNumber,DataCharParity> getMagDataParity() throws SettingsException
SettingsException - if an error occurs while retrieving the magnetic data parity.void setMagDataParity(java.util.Map<TrackNumber,DataCharParity> parity) throws SettingsException, ZebraIllegalArgumentException
parity - Map instance containing the TrackNumber and DataCharParity instance.
            SettingsException - if an error occurs while setting the magnetic data parity.ZebraIllegalArgumentException - if the parity map is invalid.PrintOptimizationMode getPrintOptimizationMode() throws SettingsException
SettingsException - if the setting does not exist, the device is busy, or there is an error communicating with the printer.
				© 2016 ZIH Corp. All Rights Reserved.