com.katalon.platform.api.service.PreferenceManager 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 com.katalon.platform.api.Application;
import com.katalon.platform.api.exception.ResourceException;
import com.katalon.platform.api.preference.ApplicationPreference;
import com.katalon.platform.api.preference.PluginPreference;

/**
 * Provides services to get {@link PluginPreference} of a loaded plugin.
 * By default, PreferenceManager is provided from the current {@link Application}
 * 
 * @since 1.0
 */
public interface PreferenceManager {
    /**
     * @param projectId project folder location of a project
     * @param pluginId full qualifier name or symbolic name of a plugin
     * @return an instance of PluginPreference that provides ability to get, and update settings value of a plugin.
     * @throws ResourceException if projectId, or pluginId is not found or invalid.
     * 
     * @see ProjectManager#getCurrentProject()
     * 
     * @since 1.0
     */
    PluginPreference getPluginPreference(String projectId, String pluginId) throws ResourceException;

    /**
     * @param projectId project folder location of a project
     * @param internalPluginId full qualifier name or symbolic name of an internal plugin
     * @return an instance of PluginPreference that provides ability to get, and update settings value of a plugin.
     * @throws ResourceException if projectId, or pluginId is not found or invalid.
     * 
     * @see ProjectManager#getCurrentProject()
     * 
     * @since 1.0
     */
    PluginPreference getInternalPluginPreference(String projectId, String internalPluginId) throws ResourceException;

    /**
     * 
     * @param pluginId the application plugin id
     * @return an instance of ApplicationPreference that provides ability to get, and update settings value of a built-in plugin.
     * 
     * @since 1.0.7
     */
    ApplicationPreference getApplicationPreference(String pluginId);
}