Module com.logicommerce.sdk

Package com.logicommerce.sdk.services

Interface DefinitionService

All Superinterfaces:

PluginService

public interface DefinitionService
extends PluginService

DefinitionService interface. To implement service of configuration properties.
These properties are the ones that can be filled from the administrator of each store.

 There are two types of configuration properties:
        - the static ones defined in the JSON config file.
        - The dynamic ones implemented through this interface.
 

 There are two types of definitions:
        - the plugin definition, this is for a plugin settings properties.
        - The connector definition, this is for a connector plugin settings properties.
 

Since:

1.0.16

Author:

Logicommerce

See Also:

PluginDefinition, ConnectorDefinition, ConnectorType

Method Summary

Modifier and Type	Method	Description
ConnectorDefinition	getConnectorDefinition(ConnectorType connectorType)	Get connector definition property by a connector type.
List<ConnectorDefinition>	getConnectorDefinitions()	Get all connector definitions properties.
PluginDefinition	getPluginDefinition()	Get plugin definition data.

Method Detail

getPluginDefinition

PluginDefinition getPluginDefinition()
                              throws PluginServiceException

Get plugin definition data. This method return plugin properties settings defined in the JSON config file and defined in this method.

Returns:

a PluginDefinition object

Throws:

PluginServiceException - PluginServiceException if any.

Since:

1.0.16

See Also:

PluginDefinition

getConnectorDefinition

ConnectorDefinition getConnectorDefinition(ConnectorType connectorType)
                                    throws PluginServiceException

Get connector definition property by a connector type. This method return plugin connector properties settings defined in the json file and defined in this method.

Parameters:

connectorType - a ConnectorType object

Returns:

a ConnectorDefinition object

Throws:

PluginServiceException - PluginServiceException if any.

Since:

1.0.16

See Also:

ConnectorType

getConnectorDefinitions

List<ConnectorDefinition> getConnectorDefinitions()
                                           throws PluginServiceException

Get all connector definitions properties.

Returns:

a List<ConnectorDefinition> object

Throws:

PluginServiceException - if any.

Since:

1.0.16

See Also:

ConnectorDefinition