com.katalon.platform.api.ExtensionPoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of com.katalon.platform Show documentation

There is a newer version: 1.0.5

package com.katalon.platform.api;

import com.katalon.platform.api.lifecycle.ExtensionListener;

/**
 * Represent for a correct ExtensionPoint of a installed Plugin.
 * 
 * An extension is declared in src/main/resources/plugin.xml file, with this sample format:
 * 
 * 
 * {@code
 * 
 *      
 * 
 * 
 * 
 * }
 * 
 *
 * @since 1.0.4
 */
public interface ExtensionPoint {
    /**
     * Id of the plugin that owns the extension point.
     * 
     * @return plugin id of the extension point
     * 
     * @since 1.0.4
     */
    String getPluginId();

    /**
     * Id of the extension point.
     * 
     * @return id of the extension point
     * 
     * @since 1.0.4
     */
    String getExtensionPointId();

    /**
     * Name of the interface class that describes all requirements of implementation should provide to extend the
     * described features.
     * 
     * @return name of the interface class
     */
    String getInterfaceClassName();

    /**
     * ExtensionListener is a service class that can listen to the registration/de-registration Extension events of the current
     * ExtensionPoint.
     * 
     * @return instance of ExtensionListener. It can be null.
     * 
     * @see ExtensionListener
     */
    ExtensionListener getServiceClass();
}