org.exoplatform.services.cms.views.impl

Class ManageViewServiceImpl

java.lang.Object

org.exoplatform.services.cms.views.impl.ManageViewServiceImpl

All Implemented Interfaces:

ManageViewService, org.picocontainer.Startable

public class ManageViewServiceImpl
extends Object
implements ManageViewService, org.picocontainer.Startable

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADMIN_VIEW
protected static String	BUTTON_PROP
protected static String	DEFAULT_VIEW
protected static String	EXO_HIDE_EXPLORER_PANEL
protected static String	EXO_PERMISSIONS
protected static String	EXO_TEMPLATE

Fields inherited from interface org.exoplatform.services.cms.views.ManageViewService

EXTENSION_TYPE

Constructor Summary

Constructors

Constructor and Description
ManageViewServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, DMSConfiguration dmsConfiguration, org.exoplatform.webui.ext.UIExtensionManager extensionManager) Constructor

Method Summary

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 homeTemplate) Adds a new template to a place with the given path.
String	addTemplate(String name, String content, String homeTemplate, org.exoplatform.services.jcr.ext.common.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, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Gets all templates.
List<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, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Gets a template by a given path.
javax.jcr.Node	getTemplateHome(String homeAlias, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Gets the template home that contains all templates.
javax.jcr.Node	getViewByName(String name, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Gets a view by its name.
javax.jcr.Node	getViewHome()
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, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Removes a template by a given path.
void	removeView(String viewName) Removes a view from the views list in the system.
void	setManageViewPlugin(ManageViewPlugin viewPlugin)
void	start()
void	stop()
String	updateTemplate(String name, String content, String homeTemplate) Updates a template at the given path.
String	updateTemplate(String name, String content, String homeTemplate, org.exoplatform.services.jcr.ext.common.SessionProvider provider) Updates a template at the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXO_TEMPLATE

protected static final String EXO_TEMPLATE

See Also:

Constant Field Values

ADMIN_VIEW

protected static final String ADMIN_VIEW

See Also:

Constant Field Values

DEFAULT_VIEW

protected static final String DEFAULT_VIEW

See Also:

Constant Field Values

EXO_PERMISSIONS

protected static final String EXO_PERMISSIONS

See Also:

Constant Field Values

EXO_HIDE_EXPLORER_PANEL

protected static final String EXO_HIDE_EXPLORER_PANEL

See Also:

Constant Field Values

BUTTON_PROP

protected static final String BUTTON_PROP

See Also:

Constant Field Values

Constructor Detail

ManageViewServiceImpl

public ManageViewServiceImpl(org.exoplatform.services.jcr.RepositoryService jcrService,
                             org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                             DMSConfiguration dmsConfiguration,
                             org.exoplatform.webui.ext.UIExtensionManager extensionManager)
                      throws Exception

Constructor

Parameters:

jcrService - : Manage repository

nodeHierarchyCreator - : Manage alias path

dmsConfiguration - : Manage dms-system workspace

extensionManager - : Manage UIComponent in each view

Throws:

Exception

Method Detail

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

init

public void init()
          throws Exception

Initializes all templates that are set in the configuration file.

Specified by:

init in interface ManageViewService

Throws:

Exception - The exception

setManageViewPlugin

public void setManageViewPlugin(ManageViewPlugin viewPlugin)

getButtons

public List<?> getButtons()

Gets all strings of buttons.

Specified by:

getButtons in interface ManageViewService

Returns:

The list of buttons.

getViewHome

public javax.jcr.Node getViewHome()
                           throws Exception

Throws:

Exception

getAllViews

public List<ViewConfig> getAllViews()
                             throws Exception

Gets all views.

Specified by:

getAllViews in interface ManageViewService

Returns:

The list of views.

Throws:

Exception - The exception

hasView

public boolean hasView(String name)
                throws Exception

Checks if a given view exists.

Specified by:

hasView in interface ManageViewService

Parameters:

name - Name of the given view.

Returns:

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

Throws:

Exception - The exception

getViewByName

public javax.jcr.Node getViewByName(String name,
                                    org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                             throws Exception

Gets a view by its name.

Specified by:

getViewByName in interface ManageViewService

Parameters:

name - Name of the view.

provider - The session provider.

Returns:

The view.

Throws:

Exception - The exception

addView

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

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

Specified by:

addView in interface ManageViewService

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

public 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.

Specified by:

addView in interface ManageViewService

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

removeView

public void removeView(String viewName)
                throws Exception

Removes a view from the views list in the system.

Specified by:

removeView in interface ManageViewService

Parameters:

viewName - Name of the removed view.

Throws:

Exception - The exception

addTab

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

Adds a new tab to the given view.

Specified by:

addTab in interface ManageViewService

Parameters:

view - The given view.

name - Name of the added tab.

buttons - Buttons of the added tab.

Throws:

Exception - The exception

getTemplateHome

public javax.jcr.Node getTemplateHome(String homeAlias,
                                      org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                               throws Exception

Gets the template home that contains all templates.

Specified by:

getTemplateHome in interface ManageViewService

Parameters:

homeAlias - Alias of the template home.

provider - The session provider.

Returns:

The template home.

Throws:

Exception - The exception

getAllTemplates

public List<javax.jcr.Node> getAllTemplates(String homeAlias,
                                            org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                     throws Exception

Gets all templates.

Specified by:

getAllTemplates in interface ManageViewService

Parameters:

homeAlias - Alias of the template home.

provider - The session provider.

Returns:

The list of templates.

Throws:

Exception - The exception

getTemplate

public javax.jcr.Node getTemplate(String path,
                                  org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                           throws Exception

Gets a template by a given path.

Specified by:

getTemplate in interface ManageViewService

Parameters:

path - The given path.

provider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

addTemplate

public String addTemplate(String name,
                          String content,
                          String homeTemplate)
                   throws Exception

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

Specified by:

addTemplate in interface ManageViewService

Parameters:

name - Name of the new template.

content - Content of the template.

homeTemplate - The given path.

Returns:

The new template.

Throws:

Exception - The exception

addTemplate

public String addTemplate(String name,
                          String content,
                          String homeTemplate,
                          org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                   throws Exception

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

Specified by:

addTemplate in interface ManageViewService

Parameters:

name - Name of the new template.

content - Content of the template.

homeTemplate - The given path.

provider - The session provider.

Returns:

The new template.

Throws:

Exception - The exception

updateTemplate

public String updateTemplate(String name,
                             String content,
                             String homeTemplate)
                      throws Exception

Updates a template at the given path.

Specified by:

updateTemplate in interface ManageViewService

Parameters:

name - Name of the updated template.

content - Content of the template.

homeTemplate - The given path.

Returns:

The template.

Throws:

Exception - The exception

updateTemplate

public String updateTemplate(String name,
                             String content,
                             String homeTemplate,
                             org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                      throws Exception

Updates a template at the given path.

Specified by:

updateTemplate in interface ManageViewService

Parameters:

name - Name of the updated template.

content - Content of the template.

homeTemplate - The given path.

provider - The session provider.

Returns:

The template.

Throws:

Exception - The exception

removeTemplate

public void removeTemplate(String templatePath)
                    throws Exception

Removes a template by a given path.

Specified by:

removeTemplate in interface ManageViewService

Parameters:

templatePath - The template path.

Throws:

Exception - The exception

removeTemplate

public void removeTemplate(String templatePath,
                           org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                    throws Exception

Removes a template by a given path.

Specified by:

removeTemplate in interface ManageViewService

Parameters:

templatePath - The template path.

provider - The session provider.

Throws:

Exception - The exception

getConfiguredTemplates

public Set<String> getConfiguredTemplates()

Description copied from interface: ManageViewService

Gets all configured templates.

Specified by:

getConfiguredTemplates in interface ManageViewService

Returns:

Set of configured templates.

getConfiguredViews

public Set<String> getConfiguredViews()

Description copied from interface: ManageViewService

Gets all configured views.

Specified by:

getConfiguredViews in interface ManageViewService

Returns:

Set of configured views.