com.neurosys.template.service

Interface TemplateStoreService<T>

Type Parameters:

T -

All Known Implementing Classes:

FileTemplateStoreService

public interface TemplateStoreService<T>

A service that defines how the actual Template-Store is loaded.
A template store refers to the actual markup file and not the Template meta data for the template.

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
T	commitTemplate(T template, String newContent) Will ensure the current saved template, creates also a rollback point for any future reverts.
Object	getDownloadableVersion(T template) Get a downloadable version of the Template as a File or some object that can be represented as a download option
String	getResourceContent(T template) Get the contents of the template
T	getTemplate(String id, String path) Get Template from id and/or path
String	getTemplateHistoryAsMarkup(T template) Get the history of the template edits (if possible) as Markup (HTML) or JSON
String	getTemplateId(T template) Get system id for the template
String	getTemplatePath(T template) Get the system path for the template
String	getTemplateType(T template) Get a type that the template represents.
List<String>	getVersionIds(T template) Get the version ids for all the templates.
List<T>	getVersions(T template) Get the versions for all the templates
boolean	isCommitPossible(T template) Any commit specific implementation available
boolean	isRevertPossible(T template) Is there a revert point to go back to for the given template
T	revertTemplate(T template, String versionId) Revert to a rollback (committed) point.
T	updateTemplate(T template, String newContent) Update template with latest content provided to the method Will make changes to the current template
String	updateTemplateHistory(T template, Map updates) Update Template History with details

Method Detail

getTemplate

T getTemplate(String id,
              String path)

Get Template from id and/or path

getTemplateType

String getTemplateType(T template)

Get a type that the template represents. This could be used to determined specific configurations for this type

getResourceContent

String getResourceContent(T template)
                   throws Exception

Get the contents of the template

Throws:

Exception

getTemplateId

String getTemplateId(T template)

Get system id for the template

getTemplatePath

String getTemplatePath(T template)

Get the system path for the template

getTemplateHistoryAsMarkup

String getTemplateHistoryAsMarkup(T template)

Get the history of the template edits (if possible) as Markup (HTML) or JSON

updateTemplateHistory

String updateTemplateHistory(T template,
                             Map updates)

Update Template History with details

updateTemplate

T updateTemplate(T template,
                 String newContent)

Update template with latest content provided to the method
Will make changes to the current template

commitTemplate

T commitTemplate(T template,
                 String newContent)

Will ensure the current saved template, creates also a rollback point for any future reverts.
A commit does not necessary imply a save (Implementation specific).

revertTemplate

T revertTemplate(T template,
                 String versionId)

Revert to a rollback (committed) point.

Parameters:

version - as String. null implies the last/latest commit point to rollback to.

isCommitPossible

boolean isCommitPossible(T template)

Any commit specific implementation available

isRevertPossible

boolean isRevertPossible(T template)

Is there a revert point to go back to for the given template

getVersions

List<T> getVersions(T template)

Get the versions for all the templates

Returns:

List of the Templates. Order of the list is assumed to chronological by default.

getVersionIds

List<String> getVersionIds(T template)

Get the version ids for all the templates. Lighter version of getVersions(Object), as it does not fetch the actual template.

Returns:

List of version ids. Order of the list is assumed to chronological by default

getDownloadableVersion

Object getDownloadableVersion(T template)

Get a downloadable version of the Template as a File or some object that can be represented as a download option