org.cyclos.services.contentmanagement

Interface StaticContentService

All Superinterfaces:

CRUDService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, Service

public interface StaticContentService
extends CRUDService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>

Service for a configuration's static content

Author:

ameyer

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHelpContent(@NotNull Role role)
StaticContentListData	getListData(@NotNull ConfigurationVO configuration) Returns data to list the static contents of a given configuration
java.lang.String	getSmsHelpContent(@NotNull Role role)
java.util.List<StaticContentVO>	list(@NotNull ConfigurationVO configuration) Lists the static contents of a given configuration
java.lang.String	previewEMail(@NotNull PreviewEmailTemplateParams params) Previews the e-mail content by applying the given template to the given user

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getHelpContent

java.lang.String getHelpContent(@NotNull
                                @NotNull Role role)
                         throws FrameworkException

Returns:

the help content according to the specified Role

Throws:

FrameworkException

getListData

StaticContentListData getListData(@NotNull
                                  @NotNull ConfigurationVO configuration)
                           throws FrameworkException

Returns data to list the static contents of a given configuration

Throws:

FrameworkException

getSmsHelpContent

java.lang.String getSmsHelpContent(@NotNull
                                   @NotNull Role role)
                            throws FrameworkException

Returns:

the sms help content. Note for version 4.0.3.x: at this moment only the role admin is supported.

Throws:

FrameworkException

list

java.util.List<StaticContentVO> list(@NotNull
                                     @NotNull ConfigurationVO configuration)
                              throws FrameworkException

Lists the static contents of a given configuration

Throws:

FrameworkException

previewEMail

java.lang.String previewEMail(@NotNull
                              @NotNull PreviewEmailTemplateParams params)
                       throws FrameworkException

Previews the e-mail content by applying the given template to the given user

Throws:

FrameworkException