ScriptService.java

/*
 * Copyright (C) 2003-2007 eXo Platform SAS.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, see<http://www.gnu.org/licenses/>.
 */
package org.exoplatform.services.cms.scripts;

import java.util.List;
import java.util.Set;

import javax.jcr.Node;
import org.exoplatform.services.jcr.ext.common.SessionProvider;

public interface ScriptService {
  
  /**
   * This method will get node for ECM Explorer Scripts by giving the following params: provider
   * @param provider      SessionProvider
   * @see                 Node
   * @see                 org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator
   * @see                 SessionProvider
   * @return              Node
   * @throws Exception
   */
  public Node getECMScriptHome(SessionProvider provider) throws Exception;
  
  /**
   * This method will get all node for ECM Action Scripts by giving the following params: provider
   * @param provider
   * @see                 Node
   * @see                 org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator
   * @see                 SessionProvider
   * @return              Node
   * @throws Exception
   */
  public List<Node> getECMActionScripts(SessionProvider provider) throws Exception;  
  
  /**
   * This method will get all node for ECM Interceptor Scripts by giving the following params: provider
   * @param provider
   * @see                 Node
   * @see                 org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator
   * @see                 SessionProvider
   * @return              nodes list
   * @throws Exception
   */
  public List<Node> getECMInterceptorScripts(SessionProvider provider) throws Exception;  
  
  /**
   * This method will get all node for ECM Widget Scripts by giving the following params: provider
   * @param provider
   * @see                 Node
   * @see                 org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator
   * @see                 SessionProvider
   * @return              nodes list
   * @throws Exception
   */
  public List<Node> getECMWidgetScripts(SessionProvider provider) throws Exception;  
  
  /**
   * This method will get script by giving the following params: scriptPath
   * @param scriptPath    String
   *                      The path of script
   * @see                 CmsScript
   * @return              CmsScript
   * @throws Exception
   */
  public CmsScript getScript(String scriptPath) throws Exception;  

  /**
   * This method will get base path of script
   * @see                 org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator
   * @return              String
   * @throws Exception
   */
  public String getBaseScriptPath() throws Exception ;

  /**
   * This method will return the script as Text based on the script node.
   * @param script        Node
   *                      The script node
   * @see                 Node
   * @return              String
   * @throws Exception
   */
  public String getScriptAsText(Node script) throws Exception;
  
  /**
   * This method will add script by giving the following params: name, text, provider
   * @param name          String
   *                      The name of script
   * @param text          String
   * @param provider      SessionProvider
   * @see                 SessionProvider
   * @throws Exception
   */
  public void addScript(String name, String text, SessionProvider provider) throws Exception;
  
  /**
   * This method will add script by giving the following params: name, text, description, provider
   * @param name          String
   *                      The name of script
   * @param text          String
   * @param description   String
   * @param provider      SessionProvider
   * @see                 SessionProvider
   * @throws Exception
   */
  public void addScript(String name, String description, String text, SessionProvider provider) throws Exception;  
  
  /**
   * This method will remove script by giving the following params: name, text, provider
   * @param scriptPath    String
   *                      The path of script
   * @param provider      SessionProvider
   * @see                 Node
   * @see                 SessionProvider
   * @throws Exception
   */
  public void removeScript(String scriptPath, SessionProvider provider) throws Exception;  
  
  /**
   * This method will get script node by giving the following params: scriptName,  provider
   * @param scriptName    String
   *                      The name of script
   * @param provider      SessionProvider
   * @see                 Node
   * @see                 SessionProvider
   * @return              Node
   * @throws Exception
   */
  public Node getScriptNode(String scriptName, SessionProvider provider) throws Exception;  
  
  /**
   * This method will init the current repository
   * @see                 org.exoplatform.services.jcr.core.ManageableRepository
   * @see                 javax.jcr.observation.ObservationManager
   * @see                 javax.jcr.Session
   * @throws Exception
   */
  public void initRepo() throws Exception;
  
  /**
   * gets all configured scripts
   * @return
   */
  public Set<String> getAllConfiguredScripts();
}