com.neurosys.template.service

Interface TemplateService

All Known Implementing Classes:

PostTemplateServiceImpl, ProductTemplateServiceImpl, TemplateServiceImpl

public interface TemplateService

Services for Template related queries

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
Map<Template,List<PageIdentifier>>	getPages(Collection<Template> templates, Status status) Get pages, categorized by the requested Templates
Template	getTemplate(Query<Template> qry) Get the Template based on a Query
Template	getTemplateByName(String name) Matches Template.getName() to get the associated template
Template	getTemplateByRefId(String refId) Use whatever reference identifier is used to refer to the template like name or bean-name (if templates defined in Spring configs) etc Note, the Ref-id is not the same as Template.getId() or Template.getName(); but can be different yet unique based on the implementation scheme of creating templates and referring to them.
String	getTemplateNameIdForContent(String contentNameId, Locale locale) Helps identify which Template is used for which Page/ContentDescriber.
<T extends Template> Collection<T>	getTemplates(Class... templateTypes) Get all templates available to context.

Method Detail

getTemplates

<T extends Template> Collection<T> getTemplates(Class... templateTypes)

Get all templates available to context.
One can optionally filter the Template by further class definitions that extend Template

Returns:

Collection of Template

getPages

Map<Template,List<PageIdentifier>> getPages(Collection<Template> templates,
                                            Status status)

Get pages, categorized by the requested Templates

Parameters:

templates - as Collection of template

{@link - Status} @nullable true (if null all Status will be picked, else pages with specified status will only be picked)

Returns:

Map of Template as key and List of PageIdentifier as value for the map.

getTemplate

Template getTemplate(Query<Template> qry)

Get the Template based on a Query

Parameters:

Query - as Query

Returns:

Template

getTemplateByName

Template getTemplateByName(String name)

Matches Template.getName() to get the associated template

getTemplateByRefId

Template getTemplateByRefId(String refId)

Use whatever reference identifier is used to refer to the template like name or bean-name (if templates defined in Spring configs) etc
Note, the Ref-id is not the same as Template.getId() or Template.getName(); but can be different yet unique based on the implementation scheme of creating templates and referring to them.
One should try and avoid this method, unless it provides a more efficient and sensibly Implementation agnostic way.

getTemplateNameIdForContent

String getTemplateNameIdForContent(String contentNameId,
                                   Locale locale)

Helps identify which Template is used for which Page/ContentDescriber.
The template can be different for different Locales; however in most use cases one would expect it to be the same. If Locale (null) is specified then it will fetch the default Template NameId (Default is defined by Locale = ContentDescriber#DEFAULT_LOCALE

See the impl, some impls may be deprecated to suggest a more efficient way.

Parameters:

contentNameId - as String @nullable false

locale - as Locale @nullable true

Returns:

String nameId