Package org.cyclos.services.contentmanagement

Interface StaticContentService

All Superinterfaces:

CRUDService<BaseStaticContentDTO,StaticContentData,StaticContentDataParams>, Service

All Known Subinterfaces:

StaticContentServiceLocal

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
List<StaticContentVO>	list(@NotNull ConfigurationVO configuration)	Lists the static contents of a given configuration
String	preview(@NotNull PreviewParams params)	Previews static content (rich text) by applying the given template for the given user or configuration.

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

list

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

Lists the static contents of a given configuration

Throws:

FrameworkException

preview

String preview(@NotNull
               @NotNull PreviewParams params)
        throws FrameworkException

Previews static content (rich text) by applying the given template for the given user or configuration. Note: When an user is provided the configuration is read from the user.

Throws:

FrameworkException