rapture.common.api.ScriptScriptApi Maven / Gradle / Ivy

Go to download
/**
 * The MIT License (MIT)
 *
 * Copyright (C) 2011-2016 Incapture Technologies LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 * This is an autogenerated file. You should not edit this file as any changes
 * will be overwritten.
 */

package rapture.common.api;
import rapture.common.CallingContext;
import rapture.common.exception.RaptureException;
import java.util.List;
import java.util.Map;
import rapture.common.ScriptResult;
import rapture.common.RaptureScriptLanguage;
import rapture.common.ScriptInterface;
import rapture.common.RaptureFolderInfo;
import rapture.common.RaptureSnippet;
import rapture.common.RaptureScript;
import rapture.common.RaptureScriptPurpose;


@SuppressWarnings("all")
public interface ScriptScriptApi {
     /**
     * 
     * 
     */
     RaptureScript createScript(String scriptURI, RaptureScriptLanguage language, RaptureScriptPurpose purpose, String script);

     /**
     * 
     * 
     */
     void createScriptLink(String fromScriptURI, String toScriptURI);

     /**
     * 
     * 
     */
     void removeScriptLink(String fromScriptURI);

     /**
     * 
     * 
     */
     Boolean doesScriptExist(String scriptURI);

     /**
     * 
     * 
     */
     void deleteScript(String scriptUri);

     /**
     * 
     * 
     */
     List getScriptNames(String scriptURI);

     /**
     * 
     * 
     */
     RaptureScript getScript(String scriptURI);

     /**
     * 
     * 
     */
     ScriptInterface getInterface(String scriptURI);

     /**
     * 
     * 
     */
     RaptureScript putScript(String scriptURI, RaptureScript script);

     /**
     * 
     * 
     */
     RaptureScript putRawScript(String scriptURI, String content, String language, String purpose, List param_types, List param_names);

     /**
     * 
     * 
     */
     String runScript(String scriptURI, Map parameters);

     /**
     * 
     * 
     */
     ScriptResult runScriptExtended(String scriptURI, Map parameters);

     /**
     * 
     * 
     */
     String checkScript(String scriptURI);

     /**
     * 
     * 
     */
     String createREPLSession();

     /**
     * 
     * 
     */
     void destroyREPLSession(String sessionId);

     /**
     * 
     * 
     */
     String evaluateREPL(String sessionId, String line);

     /**
     * 
     * 
     */
     void archiveOldREPLSessions(Long ageInMinutes);

     /**
     * 
     * 
     */
     RaptureSnippet createSnippet(String snippetURI, String snippet);

     /**
     * 
     * 
     */
     List getSnippetChildren(String prefix);

     /**
     * 
     * 
     */
     void deleteSnippet(String snippetURI);

     /**
     * 
     * 
     */
     RaptureSnippet getSnippet(String snippetURI);

     /**
     * 
     * 
     */
     Map listScriptsByUriPrefix(String scriptUri, int depth);

     /**
     * 
     * 
     */
     List deleteScriptsByUriPrefix(String scriptUri);

}