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

The newest version!

/**
 * Copyright © 2014-2021 The SiteWhere Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
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();
}