org.imixs.workflow.magento

Interface MagentoClient

All Known Implementing Classes:

MagentoRestClient, MagentoSOAPClient

public interface MagentoClient

This interface defines methods to access the Magento Web Serivce API. Magento provides two different sevice implementation. A Rest Service based on the OAuth Authentification and a SOAP Service. The Interface is used to hide the implementation details from the Imixs Magento Adapter

Author:

rsoika

Method Summary

Modifier and Type	Method and Description
void	addOrderComment(String orderIncrementId, String status, String comment, boolean notify) adds a comment to an order
void	connect(org.imixs.workflow.ItemCollection config) Connection the Client with the Magento Service.
void	disconnect() Disconnects the Client with the Magento Service.
org.imixs.workflow.ItemCollection	getCustomerById(int id)
org.imixs.workflow.ItemCollection	getOrderById(String id)
List<org.imixs.workflow.ItemCollection>	getOrders(String status)
org.imixs.workflow.ItemCollection	getProductBySKU(String sku) returns a single itemCollection for a magento product entry
List<org.imixs.workflow.ItemCollection>	getProducts() returns a List of itemCollection for magento product entries

Method Detail

connect

void connect(org.imixs.workflow.ItemCollection config)
      throws MagentoException

Connection the Client with the Magento Service. The configuration ItemCollection contains optional properties to establish the connection.

Parameters:

config -

Throws:

MagentoException

disconnect

void disconnect()

Disconnects the Client with the Magento Service.

getProducts

List<org.imixs.workflow.ItemCollection> getProducts()
                                             throws MagentoException

returns a List of itemCollection for magento product entries

Returns:

Throws:

org.imixs.workflow.exceptions.PluginException

MagentoException

getCustomerById

org.imixs.workflow.ItemCollection getCustomerById(int id)
                                           throws MagentoException

Throws:

MagentoException

getOrderById

org.imixs.workflow.ItemCollection getOrderById(String id)
                                        throws MagentoException

Throws:

MagentoException

getOrders

List<org.imixs.workflow.ItemCollection> getOrders(String status)
                                           throws MagentoException

Throws:

MagentoException

getProductBySKU

org.imixs.workflow.ItemCollection getProductBySKU(String sku)
                                           throws MagentoException

returns a single itemCollection for a magento product entry

Parameters:

item_id -

Returns:

Throws:

org.imixs.workflow.exceptions.PluginException

MagentoException

addOrderComment

void addOrderComment(String orderIncrementId,
                     String status,
                     String comment,
                     boolean notify)
              throws MagentoException

adds a comment to an order

Parameters:

item_id -

Throws:

org.imixs.workflow.exceptions.PluginException

MagentoException