com.logicommerce.sdk.services.DataService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation

SDK for developing Logicommerce plugins.

There is a newer version: 2.1.1

package com.logicommerce.sdk.services;

import java.util.Map;

/**
 * DataService interface. To implement service for fetching data that plugin may need for the front end.
 * This service is called from the resource REST /executePluginAction with the parameters defined by the plugin.
 *
 * @author Logicommerce
 * @since 1.0.16
 */
public interface DataService extends PluginService {

	/**
	 * This method is for define some action to execute in the plugin.
	 * Action parameter is to know what action should be performed.
	 * Params contains the data defined by the plugin.
	 *
	 * @param action a {@link java.lang.String String} object
	 * @param params a {@link java.util.Map Map}<{@link java.lang.String String}, {@link java.lang.String String}> object
	 * @return a {@link java.util.Map Map}<{@link java.lang.String String} {@link java.lang.Object Object}> object
	 * @since 1.0.16
	 * @throws com.logicommerce.sdk.services.PluginServiceException PluginServiceException if any.
	 */
	Map executeAction(String action, Map params) throws PluginServiceException;

}