com.ebay.sdk.attributes.model
Interface IProductFinderMaster

All Known Implementing Classes:

ProductFinderMaster

public interface IProductFinderMaster

Defines functions for rendering Product Finder HTML page and to parse the postback data of the HTML page. You need to supply XmlProvider, XslProvider and CategoryCSProvider before calling the renderHtml() method.

View UML diagram of the class.

Title: AttributesLib for Java

Description:

Copyright: Copyright (c) 2004

Company: eBay Inc.

Version:

1.0

Author:

Weijun Li

Method Summary

ICategoryCSProvider	getCategoryCSProvider() Gets provider for category information.
IProductFinderXmlProvider	getXmlProvider() Gets Xml provider.
IProductFinderXslProvider	getXslProvider() Gets XSL provider.
SearchAttributeSet[]	nameValuesToAttributeSets(Map nameValues) Parse postdata of the rendered HTML page (through renderHtml method) to extract AttributeSet objects.
String	renderHtml(CategoryType[] categories, String formSubmitUrl, String submitButtonHtml) Generates product finder HTML.
void	setCategoryCSProvider(ICategoryCSProvider CategoryCSProvider) Specifies provider for category information.
void	setXmlProvider(IProductFinderXmlProvider xmlProvider) Specifies provider for product finder XML.
void	setXslProvider(IProductFinderXslProvider xslProvider) Specifies provider for product finder XSL.

Method Detail

setXmlProvider

void setXmlProvider(IProductFinderXmlProvider xmlProvider)

Specifies provider for product finder XML.

Parameters:

xmlProvider - IProductFinderXmlProvider

getXmlProvider

IProductFinderXmlProvider getXmlProvider()

Gets Xml provider.

Returns:

IProductFinderXmlProvider

setXslProvider

void setXslProvider(IProductFinderXslProvider xslProvider)

Specifies provider for product finder XSL.

Parameters:

xslProvider - IProductFinderXslProvider

getXslProvider

IProductFinderXslProvider getXslProvider()

Gets XSL provider.

Returns:

IProductFinderXslProvider

setCategoryCSProvider

void setCategoryCSProvider(ICategoryCSProvider CategoryCSProvider)

Specifies provider for category information.

Parameters:

CategoryCSProvider - ICategoryCSProvider

getCategoryCSProvider

ICategoryCSProvider getCategoryCSProvider()

Gets provider for category information.

Returns:

ICategoryCSProvider

renderHtml

String renderHtml(CategoryType[] categories,
                  String formSubmitUrl,
                  String submitButtonHtml)
                  throws SdkException,
                         Exception

Generates product finder HTML. Typically this HTML will be displayed to the end user to collet criterias for searching products in eBay catalog.

Parameters:

categories - CategoryType[]

formSubmitUrl - String e.g., "productFinder.jsp"

submitButtonHtml - String e.g.,

Returns:

String

Throws:

SdkException

Exception

nameValuesToAttributeSets

SearchAttributeSet[] nameValuesToAttributeSets(Map nameValues)
                                               throws SdkException,
                                                      Exception

Parse postdata of the rendered HTML page (through renderHtml method) to extract AttributeSet objects.

Parameters:

nameValues - Map

Returns:

AttributeSet[]

Throws:

SdkException

Exception