com.sitewhere.spi.microservice.scripting.IScriptTemplate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sitewhere-microservice Show documentation

SiteWhere Microservice Components Library

There is a newer version: 3.0.13

Show newest version

/*
 * Copyright (c) SiteWhere, LLC. All rights reserved. http://www.sitewhere.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package com.sitewhere.spi.microservice.scripting;

/**
 * Template that provides example content for a script.
 */
public interface IScriptTemplate {

    /**
     * Get unique id which is the base filename without extension.
     * 
     * @return
     */
    String getId();

    /**
     * Get human-readable name shown in UI.
     * 
     * @return
     */
    String getName();

    /**
     * Get description of script function.
     * 
     * @return
     */
    String getDescription();

    /**
     * Get script type which is the file extension of the script content.
     * 
     * @return
     */
    String getType();
}