Summary: Methods | [Expand All]
public interface

MagentoCustomerClient

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

Summary

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

Public Methods

public abstract int createCustomer (CustomerCustomerEntityToCreate customerToCreate)

Creates a customer with th given attributes

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

public abstract int createCustomerAddress (int customerId, CustomerAddressEntityCreate 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 boolean deleteCustomer (int customerId)

Deletes a customer given its id

Parameters
customerId
Returns
  • if the customer is deleted
Throws
Exception

public abstract boolean deleteCustomerAddress (int addressId)

Deletes a Customer Address

Parameters
addressId
Returns
  • if the customer address is deleted
Throws
Exception

public abstract CustomerCustomerEntity 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 CustomerAddressEntityItem getCustomerAddress (int addressId)

Answers the customer address attributes

Parameters
addressId
Returns
  • the customer address attributes
Throws
Exception

public abstract List<CustomerAddressEntityItem> 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 List<CustomerGroupEntity> listCustomerGroups ()

Lists all the customer groups

Returns
  • a listing of groups attributes
Throws
Exception

public abstract List<CustomerCustomerEntity> 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, CustomerCustomerEntityToCreate 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, CustomerAddressEntityCreate 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