public interface ZebraTemplate
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.
|
void setTemplateFileDirectory(String directoryPath) throws IllegalArgumentException, java.io.IOException
directoryPath
- directory path for template files.IllegalArgumentException
- If the directoryPath
is invalid.java.io.IOException
- If there is an error accessing or creating the template file directory.void deleteTemplate(String templateName) throws IllegalArgumentException, ZebraCardException, java.io.IOException
templateName
- the name of the template.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.void saveTemplate(String templateName, String templateData) throws IllegalArgumentException, java.io.IOException
templateName
- the name of the template.templateData
- the XML formatted template.IllegalArgumentException
- if specified template name already exists.java.io.IOException
- on failure to store the template.String getTemplate(String templateName) throws IllegalArgumentException, java.io.IOException
templateName
- the name of the template.IllegalArgumentException
- if specified template name is invalid.java.io.IOException
- if specified template is not found or an I/O related error occurs.java.util.List<String> getAllTemplateNames() throws java.io.IOException
java.io.IOException
- if an I/O related error occurs while accessing the stored templates.java.util.List<String> getTemplateFields(String templateName) throws IllegalArgumentException, ZebraCardException, java.io.IOException
templateName
- the name of the template.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.TemplateJob generateTemplateJob(String templateName, java.util.Map<String,String> fieldDataMap) throws ZebraCardException, java.io.IOException, ConnectionException, SettingsException
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.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.TemplateJob generateTemplateDataJob(String templateData, java.util.Map<String,String> fieldDataMap) throws ConnectionException, SettingsException, ZebraCardException, java.io.IOException
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.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.void setTemplateImageFileDirectory(String directoryPath) throws IllegalArgumentException, java.io.IOException
directoryPath
- directory path for template image files.IllegalArgumentException
- If the directoryPath
is invalid.java.io.IOException
- If there is an error accessing or creating the template image file directory.void deleteTemplateImage(String imageName) throws ZebraCardException, java.io.IOException
imageName
- image name.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.java.util.List<String> getAllTemplateImageNames() throws java.io.IOException
java.io.IOException
- if an error is encountered while accessing the stored image files.byte[] getTemplateImageData(String imageName) throws java.io.IOException, IllegalArgumentException
imageName
- the name of the image.java.io.IOException
- if specified image is not found.IllegalArgumentException
- if the specified image name is empty or null.void saveTemplateImage(String imageName, byte[] imageData) throws java.io.IOException, IllegalArgumentException
imageName
- the name of the image.imageData
- the image data.java.io.IOException
- on failure to save image data.IllegalArgumentException
- if the specified image name and/or data is empty or null.java.util.Map<String,String> convertDataDocumentToDataMap(String dataDocument) throws IllegalArgumentException, ZebraCardException
dataDocument
- JSON or XML formatted template data document.ZebraCardException
- on data parsing error.IllegalArgumentException
- on invalid dataDocument
value or format.
© 2016 ZIH Corp. All Rights Reserved.