Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging.utilities
Interface LmsFileLoadPolicy

All Known Implementing Classes:
DefaultLmsFileLoadPolicy

public interface LmsFileLoadPolicy

Describes the policy of loading lms files.


Method Summary
 boolean loadFile(java.util.Collection<LmsFileHeader> loadedHeaders, LmsFileHeader lmsFileHeaderToLoad)
          This method is called when lms file is loaded.
 boolean replacePreviouslyLoadedTemplate()
          This property is checked when a template from the lms file has the same LmsMessageTemplate.getId() as one of the templates already loaded in the collection.
 

Method Detail

loadFile

boolean loadFile(java.util.Collection<LmsFileHeader> loadedHeaders,
                 LmsFileHeader lmsFileHeaderToLoad)
                 throws LoggerException
This method is called when lms file is loaded.

Parameters:
loadedHeaders - The collection of already loaded headers
lmsFileHeaderToLoad - The header of file which is being loaded
Returns:
False if file will not be loaded. True if the file will be loaded and parsed. The file header will be added to the MessageTemplateManager.getHeaders() and templates in the file will be added to the collection of templates.
Throws:
LoggerException

replacePreviouslyLoadedTemplate

boolean replacePreviouslyLoadedTemplate()
This property is checked when a template from the lms file has the same LmsMessageTemplate.getId() as one of the templates already loaded in the collection. If true, then MessageTemplateManager replaces the existing template in collection with new one. If false, then the existing LmsMessageTemplate is left in the collection instead.


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.