com.logicommerce.sdk.definition.PluginDefinition 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.3.0

package com.logicommerce.sdk.definition;

import java.util.List;
import com.logicommerce.sdk.enums.ConnectorType;

/**
 * PluginDefinition interface. To implement a plugin definition data and properties.

 * Extends {@link com.logicommerce.sdk.definition.ConfigDefinition ConfigDefinition}
 *
 * @see com.logicommerce.sdk.definition.ConfigDefinition ConfigDefinition
 * @author Logicommerce
 * @since 1.0.16
 */
public interface PluginDefinition extends ConfigDefinition {

	/**
	 * Get name of the plugin.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getName();

	/**
	 * Get description of the plugin.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getDescription();

	/**
	 * Get author of the plugin.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getAuthor();

	/**
	 * Get version of the plugin.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getVersion();
	
	/**
	 * Get true if the plugin is multiple account.
	 *
	 * @since 1.2.1
	 * @return a {@link java.lang.String String} object
	 */
	boolean getMultipleAccount();
	
	/**
	 * Get true if the plugin active User/groups filter.
	 *
	 * @since 1.2.2
	 * @return a {@link java.lang.String String} object
	 */
	boolean getUserGroupsFilter();

	/**
	 * Get true if the plugin active Country/zones filter.
	 *
	 * @since 1.2.2
	 * @return a {@link java.lang.String String} object
	 */
	boolean getCountryZonesFilter();

	/**
	 * Get all connector definitions of the plugin.
	 *
	 * @since 1.0.16
	 * @return a {@link java.util.List List}<{@link com.logicommerce.sdk.definition.ConnectorDefinition ConnectorDefinition}> object
	 */
	List getConnectorDefinitions();

	/**
	 * Add connector definition.
	 *
	 * @see com.logicommerce.sdk.definition.ConnectorDefinition ConnectorDefinition
	 * @param connectorDefinition a T object
	 * @param  a T class
	 * @since 1.0.16
	 * @throws com.logicommerce.sdk.definition.PluginDefinitionException if any.
	 */
	 void addConnectorDefinition(T connectorDefinition) throws PluginDefinitionException;

	/**
	 * Get connector definition by connectorType.
	 *
	 * @see com.logicommerce.sdk.enums.ConnectorType ConnectorType
	 * @param connectorType a {@link com.logicommerce.sdk.enums.ConnectorType} object
	 * @param  a T class
	 * @since 1.0.16
	 * @return a T object
	 */
	 T getConnectorDefinition(ConnectorType connectorType);

}