org.exoplatform.services.cms.scripts

Interface ScriptService

All Known Implementing Classes:

ScriptServiceImpl

public interface ScriptService

Method Summary

Modifier and Type	Method and Description
void	addScript(String name, String text, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will add script by giving the following params: name, text, provider
void	addScript(String name, String description, String text, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will add script by giving the following params: name, text, description, provider
Set<String>	getAllConfiguredScripts() gets all configured scripts
String	getBaseScriptPath() This method will get base path of script
List<javax.jcr.Node>	getECMActionScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get all node for ECM Action Scripts by giving the following params: provider
List<javax.jcr.Node>	getECMInterceptorScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get all node for ECM Interceptor Scripts by giving the following params: provider
javax.jcr.Node	getECMScriptHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get node for ECM Explorer Scripts by giving the following params: provider
List<javax.jcr.Node>	getECMWidgetScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get all node for ECM Widget Scripts by giving the following params: provider
CmsScript	getScript(String scriptPath) This method will get script by giving the following params: scriptPath
String	getScriptAsText(javax.jcr.Node script) This method will return the script as Text based on the script node.
javax.jcr.Node	getScriptNode(String scriptName, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will get script node by giving the following params: scriptName, provider
void	initRepo() This method will init the current repository
void	removeScript(String scriptPath, org.exoplatform.services.jcr.ext.common.SessionProvider provider) This method will remove script by giving the following params: name, text, provider

Method Detail

getECMScriptHome

javax.jcr.Node getECMScriptHome(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                         throws Exception

This method will get node for ECM Explorer Scripts by giving the following params: provider

Parameters:

provider - SessionProvider

Returns:

Node

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getECMActionScripts

List<javax.jcr.Node> getECMActionScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                  throws Exception

This method will get all node for ECM Action Scripts by giving the following params: provider

Parameters:

provider -

Returns:

Node

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getECMInterceptorScripts

List<javax.jcr.Node> getECMInterceptorScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                       throws Exception

This method will get all node for ECM Interceptor Scripts by giving the following params: provider

Parameters:

provider -

Returns:

nodes list

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getECMWidgetScripts

List<javax.jcr.Node> getECMWidgetScripts(org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                                  throws Exception

This method will get all node for ECM Widget Scripts by giving the following params: provider

Parameters:

provider -

Returns:

nodes list

Throws:

Exception

See Also:

Node, NodeHierarchyCreator, SessionProvider

getScript

CmsScript getScript(String scriptPath)
             throws Exception

This method will get script by giving the following params: scriptPath

Parameters:

scriptPath - String The path of script

Returns:

CmsScript

Throws:

Exception

See Also:

CmsScript

getBaseScriptPath

String getBaseScriptPath()
                  throws Exception

This method will get base path of script

Returns:

String

Throws:

Exception

See Also:

NodeHierarchyCreator

getScriptAsText

String getScriptAsText(javax.jcr.Node script)
                throws Exception

This method will return the script as Text based on the script node.

Parameters:

script - Node The script node

Returns:

String

Throws:

Exception

See Also:

Node

addScript

void addScript(String name,
               String text,
               org.exoplatform.services.jcr.ext.common.SessionProvider provider)
        throws Exception

This method will add script by giving the following params: name, text, provider

Parameters:

name - String The name of script

text - String

provider - SessionProvider

Throws:

Exception

See Also:

SessionProvider

addScript

void addScript(String name,
               String description,
               String text,
               org.exoplatform.services.jcr.ext.common.SessionProvider provider)
        throws Exception

This method will add script by giving the following params: name, text, description, provider

Parameters:

name - String The name of script

text - String

description - String

provider - SessionProvider

Throws:

Exception

See Also:

SessionProvider

removeScript

void removeScript(String scriptPath,
                  org.exoplatform.services.jcr.ext.common.SessionProvider provider)
           throws Exception

This method will remove script by giving the following params: name, text, provider

Parameters:

scriptPath - String The path of script

provider - SessionProvider

Throws:

Exception

See Also:

Node, SessionProvider

getScriptNode

javax.jcr.Node getScriptNode(String scriptName,
                             org.exoplatform.services.jcr.ext.common.SessionProvider provider)
                      throws Exception

This method will get script node by giving the following params: scriptName, provider

Parameters:

scriptName - String The name of script

provider - SessionProvider

Returns:

Node

Throws:

Exception

See Also:

Node, SessionProvider

initRepo

void initRepo()
       throws Exception

This method will init the current repository

Throws:

Exception

See Also:

ManageableRepository, ObservationManager, Session

getAllConfiguredScripts

Set<String> getAllConfiguredScripts()

gets all configured scripts

Returns: