Summary: Methods | [Expand All]
public interface

MagentoCustomerClient

org.mule.module.magento.api.inventory.MagentoCustomerClient<AttributesType, AttributesCollectionType, ExceptionType extends java.lang.Exception>
Known Indirect Subclasses

Summary

Public Methods
abstract int createCustomer(Map<String, Object> attributes)
Creates a customer with th given attributes
abstract int createCustomerAddress(int customerId, Map<String, Object> attributes)
Creates a new address for the given customer using the given address attributes
abstract void deleteCustomer(int customerId)
Deletes a customer given its id
abstract void deleteCustomerAddress(int addressId)
Deletes a Customer Address
abstract AttributesType getCustomer(int customerId, List<String> attributeNames)
Answers customer attributes for the given id.
abstract AttributesType getCustomerAddress(int addressId)
Answers the customer address attributes
abstract AttributesCollectionType listCustomerAddresses(int customerId)
Lists the customer address for a given customer id
abstract AttributesCollectionType listCustomerGroups()
Lists all the customer groups
abstract AttributesCollectionType listCustomers(String filters)
Answers a list of customer attributes for the given filter expression.
abstract void updateCustomer(int customerId, Map<String, Object> attributes)
Updates the given customer attributes, for the given customer id.
abstract void updateCustomerAddress(int addressId, Map<String, Object> attributes)
Updates the given map of customer address attributes, for the given customer address

Public Methods

public abstract int createCustomer (Map<String, Object> attributes)

Creates a customer with th given attributes

Parameters
attributes The attributes of the new customer
Returns
  • the new customer id
Throws
Exception

public abstract int createCustomerAddress (int customerId, Map<String, Object> attributes)

Creates a new address for the given customer using the given address attributes

Parameters
customerId
attributes
Returns
  • a new customer address id
Throws
Exception

public abstract void deleteCustomer (int customerId)

Deletes a customer given its id

Parameters
customerId
Throws
Exception

public abstract void deleteCustomerAddress (int addressId)

Deletes a Customer Address

Parameters
addressId
Throws
Exception

public abstract AttributesType getCustomer (int customerId, List<String> attributeNames)

Answers customer attributes for the given id. Only the selected attributes are retrieved

Parameters
customerId
attributeNames The attributes to retrieve. Not empty
Returns
  • the attributes map
Throws
Exception

public abstract AttributesType getCustomerAddress (int addressId)

Answers the customer address attributes

Parameters
addressId
Returns
  • the customer address attributes
Throws
Exception

public abstract AttributesCollectionType listCustomerAddresses (int customerId)

Lists the customer address for a given customer id

Parameters
customerId The id of the customer
Returns
  • a listing of addresses
Throws
Exception

public abstract AttributesCollectionType listCustomerGroups ()

Lists all the customer groups

Returns
  • a listing of groups attributes
Throws
Exception

public abstract AttributesCollectionType listCustomers (String filters)

Answers a list of customer attributes for the given filter expression.

Parameters
filters A filtering expression.
Returns
  • the attributes map
Throws
Exception

public abstract void updateCustomer (int customerId, Map<String, Object> attributes)

Updates the given customer attributes, for the given customer id. Password can not be updated using this method

Parameters
customerId
attributes The attributes map
Throws
Exception

public abstract void updateCustomerAddress (int addressId, Map<String, Object> attributes)

Updates the given map of customer address attributes, for the given customer address

Parameters
addressId The customer address to update
attributes The address attributes to update
Throws
Exception