Package org.cyclos.services.contentmanagement

Interface StaticContentService

All Superinterfaces:

CRUDService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, Service

All Known Subinterfaces:

StaticContentServiceLocal

All Known Implementing Classes:

StaticContentServiceImpl, StaticContentServiceSecurity

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

Service for a configuration's static content

Method Summary

Modifier and Type	Method	Description
String	getHelpContent(@NotNull Role role)
StaticContentListData	getListData(@NotNull ConfigurationVO configuration)	Returns data to list the static contents of a given configuration
String	getSmsHelpContent(@NotNull Role role)
List<StaticContentVO>	list(@NotNull ConfigurationVO configuration)	Lists the static contents of a given configuration
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

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

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

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

Lists the static contents of a given configuration

Throws:

FrameworkException

previewEMail

String previewEMail(@NotNull
                    @NotNull PreviewEmailTemplateParams params)
             throws FrameworkException

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

Throws:

FrameworkException