com.zebra.sdk.common.card.job.template

Interface ZebraTemplate

All Known Implementing Classes:

ZebraCardTemplate

public interface ZebraTemplate

An interface used to define functions used in template related operations.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<String,String>	convertDataDocumentToDataMap(String dataDocument) Converts a JSON or XML formatted template data document into a Map.
void	deleteTemplate(String templateName) Deletes the specified template.
void	deleteTemplateImage(String imageName) Deletes the specified template image.
TemplateJob	generateTemplateDataJob(String templateData, java.util.Map<String,String> fieldDataMap) Returns an instance of TemplateJob containing the job specific data.
TemplateJob	generateTemplateJob(String templateName, java.util.Map<String,String> fieldDataMap) Returns an instance of TemplateJob containing the job specific data.
java.util.List<String>	getAllTemplateImageNames() Gets a list of all stored template images.
java.util.List<String>	getAllTemplateNames() Returns a list containing the stored template names.
String	getTemplate(String templateName) Returns the specified template.
java.util.List<String>	getTemplateFields(String templateName) Returns the template fields from the specified XML template.
byte[]	getTemplateImageData(String imageName) Returns the raw image data from the specified image name.
void	saveTemplate(String templateName, String templateData) Saves the specified template.
void	saveTemplateImage(String imageName, byte[] imageData) Saves the specified template image.
void	setTemplateFileDirectory(String directoryPath) Sets the directory location for retrieving/storing template files.
void	setTemplateImageFileDirectory(String directoryPath) Sets the directory location for retrieving/storing template image files.

Method Detail

setTemplateFileDirectory

void setTemplateFileDirectory(String directoryPath)
                              throws IllegalArgumentException,
                                     java.io.IOException

Sets the directory location for retrieving/storing template files.

Parameters:

directoryPath - directory path for template files.

Throws:

IllegalArgumentException - If the directoryPath is invalid.

java.io.IOException - If there is an error accessing or creating the template file directory.

deleteTemplate

void deleteTemplate(String templateName)
                    throws IllegalArgumentException,
                           ZebraCardException,
                           java.io.IOException

Deletes the specified template.

Parameters:

templateName - the name of the template.

Throws:

ZebraCardException - on failure to delete the template.

IllegalArgumentException - if specified template name is invalid.

java.io.IOException - if specified template is not found or an error is encountered accessing the stored template file.

saveTemplate

void saveTemplate(String templateName,
                String templateData)
                  throws IllegalArgumentException,
                         java.io.IOException

Saves the specified template.

Parameters:

templateName - the name of the template.

templateData - the XML formatted template.

Throws:

IllegalArgumentException - if specified template name already exists.

java.io.IOException - on failure to store the template.

getTemplate

String getTemplate(String templateName)
                   throws IllegalArgumentException,
                          java.io.IOException

Returns the specified template.

Parameters:

templateName - the name of the template.

Returns:

the XML formatted template.

Throws:

IllegalArgumentException - if specified template name is invalid.

java.io.IOException - if specified template is not found or an I/O related error occurs.

getAllTemplateNames

java.util.List<String> getAllTemplateNames()
                                           throws java.io.IOException

Returns a list containing the stored template names.

Returns:

a list containing the stored template names.

Throws:

java.io.IOException - if an I/O related error occurs while accessing the stored templates.

getTemplateFields

java.util.List<String> getTemplateFields(String templateName)
                                         throws IllegalArgumentException,
                                                ZebraCardException,
                                                java.io.IOException

Returns the template fields from the specified XML template.

Parameters:

templateName - the name of the template.

Returns:

a list containing the template field names and values.

Throws:

ZebraCardException - on failure to read the stored template data.

IllegalArgumentException - if specified template name is null or empty.

java.io.IOException - if specified template is not found or an I/O related error occurs.

generateTemplateJob

TemplateJob generateTemplateJob(String templateName,
                              java.util.Map<String,String> fieldDataMap)
                                throws ZebraCardException,
                                       java.io.IOException,
                                       ConnectionException,
                                       SettingsException

Returns an instance of TemplateJob containing the job specific data.

Parameters:

templateName - the name of the template.

fieldDataMap - a map containing the template field names as the keys and the template field values for the key values.

Returns:

generated instance of TemplateJob.

Throws:

ConnectionException - if the device is busy or an error occurs communicating with the printer.

java.io.IOException - on failure to locate/access the referenced template or image files.

SettingsException - if an error occurs while generating the template job.

ZebraCardException - on template job generation error.

generateTemplateDataJob

TemplateJob generateTemplateDataJob(String templateData,
                                  java.util.Map<String,String> fieldDataMap)
                                    throws ConnectionException,
                                           SettingsException,
                                           ZebraCardException,
                                           java.io.IOException

Returns an instance of TemplateJob containing the job specific data.

Parameters:

templateData - the XML formatted template data.

fieldDataMap - a map containing the template field names as the keys and the template field values for the key values.

Returns:

generated instance of TemplateJob.

Throws:

ConnectionException - if the device is busy or an error occurs communicating with the printer.

java.io.IOException - on failure to locate/access the referenced template or image files.

SettingsException - if an error occurs while generating the template job.

ZebraCardException - on template job generation error.

setTemplateImageFileDirectory

void setTemplateImageFileDirectory(String directoryPath)
                                   throws IllegalArgumentException,
                                          java.io.IOException

Sets the directory location for retrieving/storing template image files.

Parameters:

directoryPath - directory path for template image files.

Throws:

IllegalArgumentException - If the directoryPath is invalid.

java.io.IOException - If there is an error accessing or creating the template image file directory.

deleteTemplateImage

void deleteTemplateImage(String imageName)
                         throws ZebraCardException,
                                java.io.IOException

Deletes the specified template image.

Parameters:

imageName - image name.

Throws:

ZebraCardException - on failure to delete the specified image.

java.io.IOException - if specified image is not found or an error is encountered accessing the stored image file.

getAllTemplateImageNames

java.util.List<String> getAllTemplateImageNames()
                                                throws java.io.IOException

Gets a list of all stored template images.

Returns:

a list containing the template image file names.

Throws:

java.io.IOException - if an error is encountered while accessing the stored image files.

getTemplateImageData

byte[] getTemplateImageData(String imageName)
                            throws java.io.IOException,
                                   IllegalArgumentException

Returns the raw image data from the specified image name.

Parameters:

imageName - the name of the image.

Returns:

the image data.

Throws:

java.io.IOException - if specified image is not found.

IllegalArgumentException - if the specified image name is empty or null.

saveTemplateImage

void saveTemplateImage(String imageName,
                     byte[] imageData)
                       throws java.io.IOException,
                              IllegalArgumentException

Saves the specified template image.

Parameters:

imageName - the name of the image.

imageData - the image data.

Throws:

java.io.IOException - on failure to save image data.

IllegalArgumentException - if the specified image name and/or data is empty or null.

convertDataDocumentToDataMap

java.util.Map<String,String> convertDataDocumentToDataMap(String dataDocument)
                                                          throws IllegalArgumentException,
                                                                 ZebraCardException

Converts a JSON or XML formatted template data document into a Map.

Parameters:

dataDocument - JSON or XML formatted template data document.

Returns:

a map containing the template field names as the keys and the template field values for the key values.

Throws:

ZebraCardException - on data parsing error.

IllegalArgumentException - on invalid dataDocument value or format.