com.katalon.platform.api.service.ExtensionManager 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.service;

import java.util.Collection;

import com.katalon.platform.api.Application;
import com.katalon.platform.api.Extension;
import com.katalon.platform.api.ExtensionPoint;

/**
 * ExtensionManager is a unique instance interface that maintains list of registered Extension and
 * ExtensionPoint.
 * 
 * The unique instance of ExtensionManager can access by using {@link Application#getExtensionManager()}
 * 
 * @since 1.0.4
 */
public interface ExtensionManager {

    /**
     * Returns a collection of registered Extension that points to the given extensionPointId.
     * Each Extension in the returned collection is desired to contribute the feature of the associated ExtensionPoint
     * provided.
     * 
     * This collection is immutable and cannot be changed by clients.
     * 
     * @param extensionPointId id of the ExtensionPoint.
     * @return an instance of collection of Extension. It can be empty but not null.
     * 
     * @since 1.0.4
     */
    Collection getExtensions(String extensionPointId);

    /**
     * Returns an instance of registered ExtensionPoint associated with the given extensionPointId
     * 
     * @param extensionPointId id of the ExtensionPoint.
     * @return an unique instance of ExtensionPoint. It can be null it the given extensionPointId is not
     * matched with any ExtensionPoint in ExtensionManager.
     * 
     * @since 1.0.4
     */
    ExtensionPoint getExtensionPoint(String extensionPointId);
}