org.bonitasoft.engine.theme

Interface ThemeService

All Superinterfaces:

org.bonitasoft.engine.commons.LifecycleService, org.bonitasoft.engine.commons.TenantLifecycleService

All Known Implementing Classes:

ThemeServiceImpl

public interface ThemeService
extends org.bonitasoft.engine.commons.TenantLifecycleService

Author:

Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
static String	THEME

Method Summary

Modifier and Type	Method and Description
STheme	createTheme(STheme theme) Add a new theme
void	deleteTheme(long id) Delete theme by its id
void	deleteTheme(STheme theme) Delete theme by the given theme
STheme	getLastModifiedTheme(SThemeType type) Get the last modified theme for the specific type.
long	getLastUpdateDate(SThemeType type)
long	getNumberOfThemes(QueryOptions queryOptions) Get the number of the themes corresponding to criteria
STheme	getTheme(long id) Get theme by its id
STheme	getTheme(SThemeType type, boolean isDefault) Get the default or current theme for the specific type.
void	restoreDefaultTheme(SThemeType type) Restore default theme by the given type
List<STheme>	searchThemes(QueryOptions queryOptions) Search the themes corresponding to criteria
STheme	updateTheme(STheme theme, EntityUpdateDescriptor descriptor) Update a theme by the given theme and the new content

Methods inherited from interface org.bonitasoft.engine.commons.LifecycleService

pause, resume, start, stop

Field Detail

THEME

static final String THEME

See Also:

Constant Field Values

Method Detail

createTheme

STheme createTheme(STheme theme)
            throws SThemeCreationException

Add a new theme

Parameters:

theme - The theme to create

Returns:

The created theme

Throws:

SThemeCreationException - If an exception is thrown during sTheme creation

Since:

6.2

getLastUpdateDate

long getLastUpdateDate(SThemeType type)
                throws SBonitaReadException

Throws:

SBonitaReadException

updateTheme

STheme updateTheme(STheme theme,
                   EntityUpdateDescriptor descriptor)
            throws SThemeUpdateException

Update a theme by the given theme and the new content

Parameters:

theme - The theme to update

descriptor - All attributes to update

Returns:

The updated theme

Throws:

SThemeUpdateException - If an exception is thrown during sTheme update

Since:

6.2

deleteTheme

void deleteTheme(STheme theme)
          throws SThemeNotFoundException,
                 SThemeDeletionException

Delete theme by the given theme

Parameters:

theme - The theme to delete

Throws:

SThemeNotFoundException - If the identifier does not refer to an existing sTheme

SThemeDeletionException - If an exception is thrown during sTheme deletion

Since:

6.2

deleteTheme

void deleteTheme(long id)
          throws SThemeNotFoundException,
                 SThemeDeletionException

Delete theme by its id

Parameters:

id - The identifier of the theme to delete

Throws:

SThemeNotFoundException - If the identifier does not refer to an existing sTheme

SThemeDeletionException - If an exception is thrown during sTheme deletion

Since:

6.2

restoreDefaultTheme

void restoreDefaultTheme(SThemeType type)
                  throws SRestoreThemeException

Restore default theme by the given type

Parameters:

type - The type of the theme to restore

Throws:

SRestoreThemeException - If an exception is thrown when the default theme is restored

Since:

6.2

getTheme

STheme getTheme(long id)
         throws SThemeNotFoundException,
                SThemeReadException

Get theme by its id

Parameters:

id - The identifier of the theme

Returns:

The theme

Throws:

SThemeNotFoundException - If the identifier does not refer to an existing sTheme

SThemeReadException

Since:

6.2

getTheme

STheme getTheme(SThemeType type,
                boolean isDefault)
         throws SThemeNotFoundException,
                SThemeReadException

Get the default or current theme for the specific type.

Parameters:

type - The type of the theme

isDefault - Theme is default or not

Returns:

The theme

Throws:

SThemeNotFoundException - If the type does not refer to an existing sTheme

SThemeReadException

Since:

6.2

getLastModifiedTheme

STheme getLastModifiedTheme(SThemeType type)
                     throws SThemeNotFoundException,
                            SThemeReadException

Get the last modified theme for the specific type.

Parameters:

type - The type of the theme

Returns:

The theme

Throws:

SThemeNotFoundException - If the type does not refer to an existing sTheme

SThemeReadException

Since:

6.2

getNumberOfThemes

long getNumberOfThemes(QueryOptions queryOptions)
                throws SBonitaReadException

Get the number of the themes corresponding to criteria

Parameters:

queryOptions - A map of specific parameters of a query

Returns:

A list of STheme objects

Throws:

SBonitaReadException

searchThemes

List<STheme> searchThemes(QueryOptions queryOptions)
                   throws SBonitaReadException

Search the themes corresponding to criteria

Parameters:

queryOptions - A map of specific parameters of a query

Returns:

A list of STheme objects

Throws:

SBonitaReadException