public class

AxisMagentoCatalogClient

extends AbstractMagentoClient
implements MagentoCatalogClient<AttributesType, AttributesCollectionType, ExceptionType extends Exception>
java.lang.Object
   ↳ org.mule.module.magento.api.AbstractMagentoClient
     ↳ org.mule.module.magento.api.catalog.AxisMagentoCatalogClient

Summary

[Expand]
Inherited Fields
From class org.mule.module.magento.api.AbstractMagentoClient
Public Constructors
AxisMagentoCatalogClient(AxisPortProvider provider)
Public Methods
void addCategoryProduct(int categoryId, ProductIdentifier productId, String position)
Assign product to category.
void addProductLink(String type, ProductIdentifier productId, String linkedProductIdOrSku, Map<String, Object> attributes)
Links two products
int createCategory(int parentId, Map<String, Object> attributes, String storeView)
Creates a new category.
int createProduct(String type, int set, String sku, Map<String, Object> attributes, Map<String, Object> additionalAttributes, String storeView)
Creates a new product
String createProductAttributeMedia(ProductIdentifier productId, Map<String, Object> attributes, InputStream content, MediaMimeType mimeType, String baseFileName, String storeView)
Creates a new product media.
void deleteCategory(int categoryId)
Deletes a category.
void deleteCategoryProduct(int categoryId, ProductIdentifier productId)
Remove a product assignment.
void deleteProduct(ProductIdentifier productId)
Deletes a product.
void deleteProductAttributeMedia(ProductIdentifier productId, String file)
Removes a product image.
void deleteProductLink(String type, ProductIdentifier productId, String linkedProductIdOrSku)
Deletes a product's link
int getCatalogCurrentStoreView()
Answers the current default catalog store view id for this session
Object getCategory(int categoryId, String storeView, List<String> attributeNames)
Answers category attributes.
Object getCategoryTree(String parentId, String storeView)
Retrieve hierarchical tree.
Object getProduct(ProductIdentifier productId, String storeView, List<String> attributeNames, List<String> additionalAttributeNames)
Answers a product's attributes.
Object getProductAttributeMedia(ProductIdentifier productId, String file, String storeView)
Answers product image attributes.
Object getProductSpecialPrice(ProductIdentifier productId, String storeView)
Answers a product special price.
Object[] listCategoryAttributeOptions(String attributeId, String storeView)
Retrieves attribute options.
Object[] listCategoryAttributes()
Retrieves category attributes.
Object[] listCategoryLevels(String website, String storeView, String parentCategory)
Answers levels of categories for a website, store view and parente category@return
Object[] listCategoryProducts(int categoryId)
Lists product of a given category.
Object[] listInventoryStockItems(List<String> products)
Object[] listProductAttributeMedia(ProductIdentifier productId, String storeViewIdOrCode)
Retrieves product image list.
Object[] listProductAttributeMediaTypes(int setId)
Retrieve product image types.
Object[] listProductAttributeOptions(String attributeId, String storeView)
Answers the product attribute options.
Object[] listProductAttributeSets()
Retrieves product attribute sets.
Object[] listProductAttributeTierPrices(ProductIdentifier productId)
Retrieve product tier prices.
Object[] listProductAttributes(int setId)
Retrieves product attributes list.
Object[] listProductLink(String type, ProductIdentifier productId)
Lists linked products to the given product and for the given link type
Object[] listProductLinkAttributes(String type)
Lists all the attributes for the given product link type
List<String> listProductLinkTypes()
Retrieve product link types
Object[] listProductTypes()
Retrieves product types.
Object[] listProducts(String filters, String storeView)
Retrieve products list by filters See catalog-product-list SOAP method.
void moveCategory(int categoryId, int parentId, String afterId)
Move category in tree.
void updateCatalogCurrentStoreView(String storeViewIdOrCode)
Set the default catalog store view for this session
void updateCategory(int categoryId, Map<String, Object> attributes, String storeView)
Updates a category.
void updateCategoryProduct(int categoryId, ProductIdentifier productId, String position)
void updateInventoryStockItem(ProductIdentifier productId, Map<String, Object> attributes)
Updates an stock inventory item
void updateProduct(ProductIdentifier productId, Map<String, Object> attributes, Map<String, Object> additionalAttributes, String storeView)
Updates a product.
void updateProductAttributeMedia(ProductIdentifier productId, String fileName, Map<String, Object> attributes, String storeView)
Updates product media.
void updateProductAttributeTierPrice(ProductIdentifier productId, Map<String, Object> attributes)
Updates a single product tier price.
void updateProductLink(String type, ProductIdentifier productId, String linkedProduct, Map<String, Object> attributes)
Update product link
void updateProductSpecialPrice(ProductIdentifier productId, String specialPrice, String fromDate, String toDate, String storeView)
Sets a product special price.
[Expand]
Inherited Methods
From class org.mule.module.magento.api.AbstractMagentoClient
From class java.lang.Object
From interface org.mule.module.magento.api.catalog.MagentoCatalogClient

Public Constructors

public AxisMagentoCatalogClient (AxisPortProvider provider)

Parameters
provider

Public Methods

public void addCategoryProduct (int categoryId, ProductIdentifier productId, String position)

Assign product to category. See catalog-category-assignProduct SOAP method

Parameters
categoryId
productId
position
Throws
RemoteException

public void addProductLink (String type, ProductIdentifier productId, String linkedProductIdOrSku, Map<String, Object> attributes)

Links two products

Parameters
type The product type
productId
linkedProductIdOrSku
attributes The link attributes
Throws
RemoteException

public int createCategory (int parentId, Map<String, Object> attributes, String storeView)

Creates a new category. See catalog-category-create SOAP method.

Parameters
parentId
attributes
storeView
Returns
  • the new category id
Throws
RemoteException

public int createProduct (String type, int set, String sku, Map<String, Object> attributes, Map<String, Object> additionalAttributes, String storeView)

Creates a new product

Parameters
type The new product's type
set The new product's set
sku The new product's sku
attributes The standard attributes of the new product
additionalAttributes The non standard attributes of the new product
storeView
Returns
  • the new product's id
Throws
RemoteException

public String createProductAttributeMedia (ProductIdentifier productId, Map<String, Object> attributes, InputStream content, MediaMimeType mimeType, String baseFileName, String storeView)

Creates a new product media. See catalog-product-attribute-media-create SOAP method.

Parameters
productId
attributes
content
mimeType
baseFileName
storeView
Returns
  • the new image filename
Throws
RemoteException

public void deleteCategory (int categoryId)

Deletes a category. See catalog-category-delete SOAP method

Parameters
categoryId
Throws
RemoteException

public void deleteCategoryProduct (int categoryId, ProductIdentifier productId)

Remove a product assignment. See catalog-category-removeProduct SOAP method.

Parameters
categoryId
productId
Throws
RemoteException

public void deleteProduct (ProductIdentifier productId)

Deletes a product. See catalog-product-delete SOAP method.

Parameters
productId The product identifier
Throws
RemoteException

public void deleteProductAttributeMedia (ProductIdentifier productId, String file)

Removes a product image. See catalog-product-attribute-media-remove SOAP method.

Parameters
productId
file
Throws
RemoteException

public void deleteProductLink (String type, ProductIdentifier productId, String linkedProductIdOrSku)

Deletes a product's link

Parameters
type Link type
productId
linkedProductIdOrSku
Throws
RemoteException

public int getCatalogCurrentStoreView ()

Answers the current default catalog store view id for this session

Returns
  • the current default store view id
Throws
RemoteException

public Object getCategory (int categoryId, String storeView, List<String> attributeNames)

Answers category attributes. See catalog-category-info SOAP method.

Parameters
categoryId
storeView
attributeNames
Returns
  • the category attributes
Throws
RemoteException

public Object getCategoryTree (String parentId, String storeView)

Retrieve hierarchical tree. See catalog-category-tree SOAP method.

Parameters
parentId
storeView
Throws
RemoteException

public Object getProduct (ProductIdentifier productId, String storeView, List<String> attributeNames, List<String> additionalAttributeNames)

Answers a product's attributes. See catalog-product-info SOAP method.

Parameters
productId
storeView
attributeNames The list of standard attributes to be returned
additionalAttributeNames The list of non standard attributes to be returned in the additionalAttributes attribute
Returns
  • the product attributes
Throws
RemoteException

public Object getProductAttributeMedia (ProductIdentifier productId, String file, String storeView)

Answers product image attributes. See catalog-product-attribute-media-info SOAP method

Parameters
productId
file
storeView
Returns
  • the product attributes
Throws
RemoteException

public Object getProductSpecialPrice (ProductIdentifier productId, String storeView)

Answers a product special price. See catalog-product-getSpecialPrice SOAP method.

Parameters
productId
storeView
Throws
RemoteException

public Object[] listCategoryAttributeOptions (String attributeId, String storeView)

Retrieves attribute options. See catalog-category-attribute-options SOAP method.

Parameters
attributeId
storeView
Returns
  • the list of attributes
Throws
RemoteException

public Object[] listCategoryAttributes ()

Retrieves category attributes. See catalog-category-attribute-list SOAP method.

Returns
  • the list of attributes
Throws
RemoteException

public Object[] listCategoryLevels (String website, String storeView, String parentCategory)

Answers levels of categories for a website, store view and parente category@return

Parameters
website
storeView
parentCategory
Throws
RemoteException

public Object[] listCategoryProducts (int categoryId)

Lists product of a given category. See catalog-category-assignedProducts SOAP method.

Parameters
categoryId
Returns
  • the listing of category products
Throws
RemoteException

public Object[] listInventoryStockItems (List<String> products)

Parameters
products
Throws
RemoteException

public Object[] listProductAttributeMedia (ProductIdentifier productId, String storeViewIdOrCode)

Retrieves product image list. See catalog-product-attribute-media-list SOAP method

Parameters
productId
storeViewIdOrCode
Returns
  • the list of product images attributes
Throws
RemoteException

public Object[] listProductAttributeMediaTypes (int setId)

Retrieve product image types. See catalog-product-attribute-media-types SOAP method.

Parameters
setId
Throws
RemoteException

public Object[] listProductAttributeOptions (String attributeId, String storeView)

Answers the product attribute options. See catalog-product-attribute-options SOAP method.

Parameters
attributeId
storeView
Returns
  • the attributes list
Throws
RemoteException

public Object[] listProductAttributeSets ()

Retrieves product attribute sets. See catalog-product-attribute-set-list SOAP method.

Returns
  • The list of product attributes sets
Throws
RemoteException

public Object[] listProductAttributeTierPrices (ProductIdentifier productId)

Retrieve product tier prices. See catalog-product-attribute-tier-price-info SOAP Method.

Parameters
productId
Returns
  • the list of product attributes
Throws
RemoteException

public Object[] listProductAttributes (int setId)

Retrieves product attributes list. See catalog-product-attribute-list SOAP methods

Parameters
setId
Returns
  • the list of product attributes
Throws
RemoteException

public Object[] listProductLink (String type, ProductIdentifier productId)

Lists linked products to the given product and for the given link type

Parameters
type The link type
productId The linked product
Returns
  • the list of links to the product
Throws
RemoteException

public Object[] listProductLinkAttributes (String type)

Lists all the attributes for the given product link type

Parameters
type The product type
Returns
  • the listing of product attributes
Throws
RemoteException

public List<String> listProductLinkTypes ()

Retrieve product link types

Returns
  • the list of product link types
Throws
RemoteException

public Object[] listProductTypes ()

Retrieves product types. See catalog-product-type-list SOAP method

Returns
  • the list of product types
Throws
RemoteException

public Object[] listProducts (String filters, String storeView)

Retrieve products list by filters See catalog-product-list SOAP method.

Parameters
filters An optional filtering expression
storeView
Returns
  • the list of product attributes that match the given optional filtering expression
Throws
RemoteException

public void moveCategory (int categoryId, int parentId, String afterId)

Move category in tree. See catalog-category-move SOAP method.

Parameters
categoryId
parentId
afterId
Throws
RemoteException

public void updateCatalogCurrentStoreView (String storeViewIdOrCode)

Set the default catalog store view for this session

Parameters
storeViewIdOrCode The id or code of the store view to set as default for this session
Throws
RemoteException

public void updateCategory (int categoryId, Map<String, Object> attributes, String storeView)

Updates a category. See catalog-category-update SOAP method

Parameters
categoryId
attributes
storeView
Throws
RemoteException

public void updateCategoryProduct (int categoryId, ProductIdentifier productId, String position)

Parameters
categoryId
productId
position
Throws
RemoteException

public void updateInventoryStockItem (ProductIdentifier productId, Map<String, Object> attributes)

Updates an stock inventory item

Parameters
productId
attributes
Throws
RemoteException

public void updateProduct (ProductIdentifier productId, Map<String, Object> attributes, Map<String, Object> additionalAttributes, String storeView)

Updates a product. At least one of attributes or additionalAttributes must be non null and non empty. See catalog-category-updateProduct SOAP method

Parameters
productId
attributes The map of standard product attributes to update
additionalAttributes The map of non standard product attributes to update
storeView
Throws
RemoteException

public void updateProductAttributeMedia (ProductIdentifier productId, String fileName, Map<String, Object> attributes, String storeView)

Updates product media. See catalog-product-attribute-media-update

Parameters
productId
fileName
attributes
storeView
Throws
RemoteException

public void updateProductAttributeTierPrice (ProductIdentifier productId, Map<String, Object> attributes)

Updates a single product tier price. See catalog-product-attribute-tier-price-update SOAP method.

Parameters
productId
attributes
Throws
RemoteException

public void updateProductLink (String type, ProductIdentifier productId, String linkedProduct, Map<String, Object> attributes)

Update product link

Parameters
type
productId
linkedProduct
attributes
Throws
RemoteException

public void updateProductSpecialPrice (ProductIdentifier productId, String specialPrice, String fromDate, String toDate, String storeView)

Sets a product special price. See catalog-product-setSpecialPrice SOAP method

Parameters
productId
specialPrice
fromDate
toDate
storeView
Throws
RemoteException