net.sf.jcopist.service
Interface ITemplateService

public interface ITemplateService

Describes the template service, which allows clients to upload new templates or update existing ones.

Method Summary

void	register(java.lang.String _templateName, java.lang.String _extension, byte[] _templateData) Registers a template.
void	unregister(java.lang.String _templateName) Unregisters a template.

Method Detail

register

void register(java.lang.String _templateName,
              java.lang.String _extension,
              byte[] _templateData)
              throws UnavailableException,
                     ServerException

Registers a template.
If a template with the same name already exists, it will be replaced.

Parameters:

_templateName - the name that will be used to identify the template.

_extension - the extension of the template.

_templateData - the data of the template file.

Throws:

UnavailableException - if the template service is not activated on the server, or if the server is shutting down and doesn't accept any more requests.

ServerException - if an internal error occurs.

unregister

void unregister(java.lang.String _templateName)
                throws UnavailableException,
                       ServerException

Unregisters a template.

Parameters:

_templateName - the name that will be used to identify the template.

Throws:

UnavailableException - if the template service is not activated on the server, or if the server is shutting down and doesn't accept any more requests.

ServerException - if an internal error occurs.