org.exoplatform.services.cms.views

Interface ManageViewService

public interface ManageViewService

Manages views, including adding, editing, deleting and getting.

Level API:

Experimental

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_TYPE The type of extension related to this service.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTab(javax.jcr.Node view, String name, String buttons) Adds a new tab to the given view.
String	addTemplate(String name, String content, String homePath) Adds a new template to a place with the given path.
String	addTemplate(String name, String content, String homePath, SessionProvider provider) Adds a new template to a place with the given path.
void	addView(String name, String permissions, boolean hideExplorerPanel, String template, List<?> tabs) Adds a new view to the system by giving the following params.
void	addView(String name, String permissions, String template, List<?> tabs) Adds a new view to the system by giving the following params.
List<javax.jcr.Node>	getAllTemplates(String homeAlias, SessionProvider provider) Gets all templates.
List<org.exoplatform.services.cms.views.ViewConfig>	getAllViews() Gets all views.
List<?>	getButtons() Gets all strings of buttons.
Set<String>	getConfiguredTemplates() Gets all configured templates.
Set<String>	getConfiguredViews() Gets all configured views.
javax.jcr.Node	getTemplate(String path, SessionProvider provider) Gets a template by a given path.
javax.jcr.Node	getTemplateHome(String homeAlias, SessionProvider provider) Gets the template home that contains all templates.
javax.jcr.Node	getViewByName(String viewName, SessionProvider provider) Gets a view by its name.
boolean	hasView(String name) Checks if a given view exists.
void	init() Initializes all templates that are set in the configuration file.
void	removeTemplate(String templatePath) Removes a template by a given path.
void	removeTemplate(String templatePath, SessionProvider provider) Removes a template by a given path.
void	removeView(String viewName) Removes a view from the views list in the system.
String	updateTemplate(String name, String content, String homePath) Updates a template at the given path.
String	updateTemplate(String name, String content, String homePath, SessionProvider provider) Updates a template at the given path.

Field Detail

EXTENSION_TYPE

static final String EXTENSION_TYPE

The type of extension related to this service.

See Also:

Constant Field Values

Method Detail

addView

void addView(String name,
           String permissions,
           String template,
           List<?> tabs)
             throws Exception

Adds a new view to the system by giving the following params.

Parameters:

name - Name of the view.

permissions - Who can access the view.

template - Name of the templated used by the added view.

tabs - Tabs of the added view.

Throws:

Exception - The exception

addView

void addView(String name,
           String permissions,
           boolean hideExplorerPanel,
           String template,
           List<?> tabs)
             throws Exception

Adds a new view to the system by giving the following params.

Parameters:

name - Name of the view.

permissions - Who can access the view.

hideExplorerPanel - If "true", the explorer panel is hidden. If "false", the explorer panel is shown.

template - Name of the templated used by the added view.

tabs - Tabs of the added view.

Throws:

Exception - The exception

getViewByName

javax.jcr.Node getViewByName(String viewName,
                           SessionProvider provider)
                             throws Exception

Gets a view by its name.

Parameters:

viewName - Name of the view.

provider - The session provider.

Returns:

The view.

Throws:

Exception - The exception

getButtons

List<?> getButtons()
                   throws Exception

Gets all strings of buttons.

Returns:

The list of buttons.

Throws:

Exception - The exception

removeView

void removeView(String viewName)
                throws Exception

Removes a view from the views list in the system.

Parameters:

viewName - Name of the removed view.

Throws:

Exception - The exception

getAllViews

List<org.exoplatform.services.cms.views.ViewConfig> getAllViews()
                                                                throws Exception

Gets all views.

Returns:

The list of views.

Throws:

Exception - The exception

hasView

boolean hasView(String name)
                throws Exception

Checks if a given view exists.

Parameters:

name - Name of the given view.

Returns:

"True" if the given view exists. Otherwise, it returns "false".

Throws:

Exception - The exception

getTemplateHome

javax.jcr.Node getTemplateHome(String homeAlias,
                             SessionProvider provider)
                               throws Exception

Gets the template home that contains all templates.

Parameters:

homeAlias - Alias of the template home.

provider - The session provider.

Returns:

The template home.

Throws:

Exception - The exception

getAllTemplates

List<javax.jcr.Node> getAllTemplates(String homeAlias,
                                   SessionProvider provider)
                                     throws Exception

Gets all templates.

Parameters:

homeAlias - Alias of the template home.

provider - The session provider.

Returns:

The list of templates.

Throws:

Exception - The exception

getTemplate

javax.jcr.Node getTemplate(String path,
                         SessionProvider provider)
                           throws Exception

Gets a template by a given path.

Parameters:

path - The given path.

provider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

addTemplate

String addTemplate(String name,
                 String content,
                 String homePath)
                   throws Exception

Adds a new template to a place with the given path.

Parameters:

name - Name of the new template.

content - Content of the template.

homePath - The given path.

Returns:

The new template.

Throws:

Exception - The exception

addTemplate

String addTemplate(String name,
                 String content,
                 String homePath,
                 SessionProvider provider)
                   throws Exception

Adds a new template to a place with the given path.

Parameters:

name - Name of the new template.

content - Content of the template.

homePath - The given path.

provider - The session provider.

Returns:

The new template.

Throws:

Exception - The exception

updateTemplate

String updateTemplate(String name,
                    String content,
                    String homePath)
                      throws Exception

Updates a template at the given path.

Parameters:

name - Name of the updated template.

content - Content of the template.

homePath - The given path.

Returns:

The template.

Throws:

Exception - The exception

updateTemplate

String updateTemplate(String name,
                    String content,
                    String homePath,
                    SessionProvider provider)
                      throws Exception

Updates a template at the given path.

Parameters:

name - Name of the updated template.

content - Content of the template.

homePath - The given path.

provider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

removeTemplate

void removeTemplate(String templatePath)
                    throws Exception

Removes a template by a given path.

Parameters:

templatePath - The template path.

Throws:

Exception - The exception

removeTemplate

void removeTemplate(String templatePath,
                  SessionProvider provider)
                    throws Exception

Removes a template by a given path.

Parameters:

templatePath - The template path.

provider - The session provider.

Throws:

Exception - The exception

addTab

void addTab(javax.jcr.Node view,
          String name,
          String buttons)
            throws Exception

Adds a new tab to the given view.

Parameters:

view - The given view.

name - Name of the added tab.

buttons - Buttons of the added tab.

Throws:

Exception - The exception

init

void init()
          throws Exception

Initializes all templates that are set in the configuration file.

Throws:

Exception - The exception

getConfiguredTemplates

Set<String> getConfiguredTemplates()

Gets all configured templates.

Returns:

Set of configured templates.

getConfiguredViews

Set<String> getConfiguredViews()

Gets all configured views.

Returns:

Set of configured views.