Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.worldpac.catalog
Class Catalog

java.lang.Object
  |
  +--com.worldpac.catalog.Catalog
public class Catalog
extends java.lang.Object

Contains static methods for retreiving all catalog data except vehicle-to-product applications.

Constructor Summary
Catalog()
           
 
Method Summary
static boolean catShouldBeEnabled(Category cat, java.util.Vector performanceCategoryVector)
           
static java.util.Hashtable getAllBrands(com.worldpac.dca.Server server)
           
static java.util.Vector getCategories(com.worldpac.dca.Server server, java.util.Vector categoryVector, java.lang.String year, java.lang.String make, java.lang.String modelID, java.lang.String categoryID, boolean showChildren, java.util.Vector performanceCategoryVector)
           
static java.util.Vector getCategories(java.lang.String categoryID, boolean showChildren)
          Get part categories.
static java.util.Vector getCategories(java.lang.String partnerID, java.util.Vector categoryVector, java.lang.String year, java.lang.String make, java.lang.String modelID, java.lang.String categoryID, boolean showChildren)
           
static java.util.Vector getCategories(java.lang.String partnerID, java.util.Vector categoryVector, java.lang.String year, java.lang.String make, java.lang.String modelID, java.lang.String categoryID, boolean showChildren, java.util.Vector performanceCategoryVector)
           
static java.lang.String getCategoryDescription(java.lang.String categoryID)
          Get part category description.
static int getCategoryLevel(java.lang.String categoryID)
          Get part category level.
static java.lang.String getMakeDesc(java.lang.String makeID)
           
static java.lang.String getMakeDescription(java.lang.String makeID)
          Get vehicle make description.
static java.util.Vector getMakes()
          Get vehicle makes.
static Model getModel(java.lang.String key)
           
static java.lang.String getModelDescription(java.lang.String modelID)
          Deprecated. Replaced by getModelDescription(String, String) *
static java.lang.String getModelDescription(java.lang.String makeID, java.lang.String modelID)
          Get vehicle model description.
static java.util.Vector getModels(com.worldpac.dca.Server server, java.lang.String year, java.lang.String makeID)
           
static java.util.Vector getModels(java.lang.String partnerID, java.lang.String year, java.lang.String makeID)
          Get vehicle models.
static java.util.Vector getNVSParts(com.worldpac.dca.Server server, java.lang.String categoryID)
           
static java.util.Vector getNVSParts(java.lang.String partnerID, java.lang.String categoryID)
          Get parts.
static java.util.Vector getParts(com.worldpac.dca.Server server, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String text)
           
static java.util.Vector getParts(java.lang.String partnerID, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String text)
          Get parts.
static java.util.Vector getPerformanceParts(com.worldpac.dca.Server server, java.lang.String year, java.lang.String make, java.lang.String modelId, java.lang.String category, java.lang.String text)
           
static java.util.Vector getPerformanceParts(java.lang.String partnerID, java.lang.String year, java.lang.String make, java.lang.String modelId, java.lang.String category, java.lang.String text)
           
static Product getProduct(com.worldpac.dca.Server server, java.lang.String applicationID)
           
static Product getProduct(java.lang.String partnerID, java.lang.String applicationID)
          Get product.
static java.util.Vector getProductQuotes(com.worldpac.dca.Server server, Product product)
          Get product quotes.
static java.util.Vector getProductQuotes(java.lang.String partnerID, Product product)
           
static java.util.Vector getProducts(com.worldpac.dca.Server server, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String part)
           
static java.util.Vector getProducts(java.lang.String partnerID, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String part)
          Get products.
static java.lang.String getRequestedString(java.lang.String str)
           
static java.util.Vector getSearchParts(com.worldpac.dca.Server server, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String text)
           
static java.util.Vector getSearchParts(java.lang.String partnerID, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String text)
           
static Shipping getShipping(java.lang.String partnerID, java.lang.String orderID, java.lang.String userData)
          Get shipping.
static java.lang.String getText(java.lang.String tag, org.w3c.dom.Node node)
          METHOD - return the text of the given tag for the given node
static java.util.Vector getWPCategories(java.lang.String categoryID, boolean showChildren)
          Get WebParts part categories.
static java.util.Vector getWPParts(java.lang.String partnerID, java.lang.String year, java.lang.String makeID, java.lang.String modelID, java.lang.String categoryID, java.lang.String text)
           
static java.util.Vector getWPVector(com.worldpac.dca.Server server, java.lang.String categoryID, boolean showChildren, java.lang.String catLevel, boolean allParts, java.lang.String year, java.lang.String make, java.lang.String model, boolean isPerformance)
           
static java.util.Vector getWPVector(java.lang.String partnerID, java.lang.String categoryID, boolean showChildren, java.lang.String catLevel, boolean allParts, java.lang.String year, java.lang.String make, java.lang.String model, boolean isPerformance)
           
static Shipping setShippingService(java.lang.String partnerID, java.lang.String orderID, java.lang.String userData, int line, java.lang.String shippingServiceID, java.lang.String warehouseID)
          Set shipping service.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Catalog

public Catalog()
Method Detail

getAllBrands

public static java.util.Hashtable getAllBrands(com.worldpac.dca.Server server)

getRequestedString

public static final java.lang.String getRequestedString(java.lang.String str)

getMakeDesc

public static final java.lang.String getMakeDesc(java.lang.String makeID)

getText

public static java.lang.String getText(java.lang.String tag,
                                       org.w3c.dom.Node node)
METHOD - return the text of the given tag for the given node

getMakes

public static java.util.Vector getMakes()
Get vehicle makes.

Returns:
A vector of Makes

getMakeDescription

public static java.lang.String getMakeDescription(java.lang.String makeID)
Get vehicle make description.

Parameters:
makeID - Worldpac vehicle make identifier
Returns:
Text description of the vehicle make

getModels

public static java.util.Vector getModels(java.lang.String partnerID,
                                         java.lang.String year,
                                         java.lang.String makeID)
                                  throws com.worldpac.dca.ServerException
Get vehicle models.

Parameters:
partnerID - Partner identifier
year - Model year
makeID - Worldpac vehicle make identifier
Returns:
A vector of Models
com.worldpac.dca.ServerException

getModels

public static java.util.Vector getModels(com.worldpac.dca.Server server,
                                         java.lang.String year,
                                         java.lang.String makeID)
                                  throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getModelDescription

public static java.lang.String getModelDescription(java.lang.String modelID)
Deprecated. Replaced by getModelDescription(String, String) *

Get vehicle model description.

Parameters:
modelID - Worldpac vehicle model identifier
Returns:
Text description of the model

getModelDescription

public static java.lang.String getModelDescription(java.lang.String makeID,
                                                   java.lang.String modelID)
Get vehicle model description.

Parameters:
makeID - Worldpac vehicle make identifier
modelID - Worldpac vehicle model identifier
Returns:
Text description of the model

getModel

public static Model getModel(java.lang.String key)

getWPCategories

public static java.util.Vector getWPCategories(java.lang.String categoryID,
                                               boolean showChildren)
Get WebParts part categories.

Parameters:
categoryID - Worldpac part category identifier
showChildren - True if the returned Vector should list the children of the part category. False if the part category's siblings should be listed instead.
Returns:
A vector of Categories

getPerformanceParts

public static java.util.Vector getPerformanceParts(java.lang.String partnerID,
                                                   java.lang.String year,
                                                   java.lang.String make,
                                                   java.lang.String modelId,
                                                   java.lang.String category,
                                                   java.lang.String text)
                                            throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getPerformanceParts

public static java.util.Vector getPerformanceParts(com.worldpac.dca.Server server,
                                                   java.lang.String year,
                                                   java.lang.String make,
                                                   java.lang.String modelId,
                                                   java.lang.String category,
                                                   java.lang.String text)

catShouldBeEnabled

public static boolean catShouldBeEnabled(Category cat,
                                         java.util.Vector performanceCategoryVector)

getWPVector

public static java.util.Vector getWPVector(java.lang.String partnerID,
                                           java.lang.String categoryID,
                                           boolean showChildren,
                                           java.lang.String catLevel,
                                           boolean allParts,
                                           java.lang.String year,
                                           java.lang.String make,
                                           java.lang.String model,
                                           boolean isPerformance)
                                    throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getWPVector

public static java.util.Vector getWPVector(com.worldpac.dca.Server server,
                                           java.lang.String categoryID,
                                           boolean showChildren,
                                           java.lang.String catLevel,
                                           boolean allParts,
                                           java.lang.String year,
                                           java.lang.String make,
                                           java.lang.String model,
                                           boolean isPerformance)

getCategories

public static java.util.Vector getCategories(java.lang.String categoryID,
                                             boolean showChildren)
Get part categories.

Parameters:
categoryID - Worldpac part category identifier
showChildren - True if the returned Vector should list the children of the part category. False if the part category's siblings should be listed instead.
Returns:
A vector of Categories

getCategories

public static java.util.Vector getCategories(java.lang.String partnerID,
                                             java.util.Vector categoryVector,
                                             java.lang.String year,
                                             java.lang.String make,
                                             java.lang.String modelID,
                                             java.lang.String categoryID,
                                             boolean showChildren,
                                             java.util.Vector performanceCategoryVector)
                                      throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getCategories

public static java.util.Vector getCategories(com.worldpac.dca.Server server,
                                             java.util.Vector categoryVector,
                                             java.lang.String year,
                                             java.lang.String make,
                                             java.lang.String modelID,
                                             java.lang.String categoryID,
                                             boolean showChildren,
                                             java.util.Vector performanceCategoryVector)
                                      throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getCategories

public static java.util.Vector getCategories(java.lang.String partnerID,
                                             java.util.Vector categoryVector,
                                             java.lang.String year,
                                             java.lang.String make,
                                             java.lang.String modelID,
                                             java.lang.String categoryID,
                                             boolean showChildren)
                                      throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getCategoryDescription

public static java.lang.String getCategoryDescription(java.lang.String categoryID)
Get part category description.

Parameters:
categoryID - Worldpac part category identifier
Returns:
Text description of the part category

getCategoryLevel

public static int getCategoryLevel(java.lang.String categoryID)
Get part category level.

Parameters:
categoryID - Worldpac part category identifier
Returns:
The depth of the part category, where the root depth is 0.

getParts

public static java.util.Vector getParts(java.lang.String partnerID,
                                        java.lang.String year,
                                        java.lang.String makeID,
                                        java.lang.String modelID,
                                        java.lang.String categoryID,
                                        java.lang.String text)
                                 throws com.worldpac.dca.ServerException
Get parts.

Parameters:
partnerID - Partner identifier
year - Model year
makeID - Worldpac vehicle make identifier
modelID - Worldpac vehicle model identifier
categoryID - Worldpac part category identifier
text - Search criteria
Returns:
A vector of Parts
com.worldpac.dca.ServerException

getParts

public static java.util.Vector getParts(com.worldpac.dca.Server server,
                                        java.lang.String year,
                                        java.lang.String makeID,
                                        java.lang.String modelID,
                                        java.lang.String categoryID,
                                        java.lang.String text)
                                 throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getSearchParts

public static java.util.Vector getSearchParts(java.lang.String partnerID,
                                              java.lang.String year,
                                              java.lang.String makeID,
                                              java.lang.String modelID,
                                              java.lang.String categoryID,
                                              java.lang.String text)
                                       throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getSearchParts

public static java.util.Vector getSearchParts(com.worldpac.dca.Server server,
                                              java.lang.String year,
                                              java.lang.String makeID,
                                              java.lang.String modelID,
                                              java.lang.String categoryID,
                                              java.lang.String text)
                                       throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getNVSParts

public static java.util.Vector getNVSParts(java.lang.String partnerID,
                                           java.lang.String categoryID)
                                    throws com.worldpac.dca.ServerException
Get parts.

Parameters:
partnerID - Partner identifier (required)
categoryID - Worldpac part category identifier
Returns:
A vector with a combination of Part, NVSPart, and ProductQuote objects

The returned Vector may contain one or more objects of different data types.

Incoming parameter values determine the result set.

Example 1 (default catalog set)

  • all parameters (except partnerID) are null

vector contains 0 or more ProductQuote objects

Example 2 (General Purpose Part category selected)

  • year, makeID, modelID, and text may or may not be null.
  • categoryID is a code which begins with "N_"

vector contains 0 or more ProductQuote objects, and 0 or more NVSPart objects

Example 3 (Replacement or Performance parts selected)

  • year, makeID, and modelID may not be null.
  • categoryID is a code which does NOT begin with "N_"

vector contains 0 or more Part objects

Example 4 (Text search with or without application selected)

  • year, makeID, modelID may or may not be null.
  • categoryID is null
  • text has search string

vector contains 0 or more ProductQuote objects, 0 or more Part objects, and 0 or more NVSPart objects

com.worldpac.dca.ServerException

getNVSParts

public static java.util.Vector getNVSParts(com.worldpac.dca.Server server,
                                           java.lang.String categoryID)
                                    throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getWPParts

public static java.util.Vector getWPParts(java.lang.String partnerID,
                                          java.lang.String year,
                                          java.lang.String makeID,
                                          java.lang.String modelID,
                                          java.lang.String categoryID,
                                          java.lang.String text)
                                   throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getProducts

public static java.util.Vector getProducts(java.lang.String partnerID,
                                           java.lang.String year,
                                           java.lang.String makeID,
                                           java.lang.String modelID,
                                           java.lang.String categoryID,
                                           java.lang.String part)
                                    throws com.worldpac.dca.ServerException
Get products.

Parameters:
partnerID - Partner identifier
year - Model year
makeID - Worldpac vehicle make identifier
modelID - Worldpac vehicle model identifier
categoryID - Worldpac part category identifier
part - Part description
Returns:
A vector of Products
com.worldpac.dca.ServerException

getProducts

public static java.util.Vector getProducts(com.worldpac.dca.Server server,
                                           java.lang.String year,
                                           java.lang.String makeID,
                                           java.lang.String modelID,
                                           java.lang.String categoryID,
                                           java.lang.String part)
                                    throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getProduct

public static Product getProduct(java.lang.String partnerID,
                                 java.lang.String applicationID)
                          throws com.worldpac.dca.ServerException
Get product.

Parameters:
partnerID - Partner identifier
applicationID - Worldpac application identifier
Returns:
The Product for the requested application ID
com.worldpac.dca.ServerException

getProduct

public static Product getProduct(com.worldpac.dca.Server server,
                                 java.lang.String applicationID)
                          throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getProductQuotes

public static java.util.Vector getProductQuotes(java.lang.String partnerID,
                                                Product product)
                                         throws com.worldpac.dca.ServerException
com.worldpac.dca.ServerException

getProductQuotes

public static java.util.Vector getProductQuotes(com.worldpac.dca.Server server,
                                                Product product)
                                         throws com.worldpac.dca.ServerException
Get product quotes.

Parameters:
product - A Product for which to get quotes.
Returns:
A vector of ProductQuotes
com.worldpac.dca.ServerException

getShipping

public static Shipping getShipping(java.lang.String partnerID,
                                   java.lang.String orderID,
                                   java.lang.String userData)
                            throws com.worldpac.dca.ServerException
Get shipping. Get details of the shipping options currently selected for an order.

Parameters:
partnerID - Partner identifier
orderID - Worldpac order identifier. Obtained by building an order using the fulfillment package and calling Order.getOrderID().
userData - The userData that was provided when the order was created. For verification.
Returns:
A Shipping object containing details of the shipping options currently selected for the order.
com.worldpac.dca.ServerException

setShippingService

public static Shipping setShippingService(java.lang.String partnerID,
                                          java.lang.String orderID,
                                          java.lang.String userData,
                                          int line,
                                          java.lang.String shippingServiceID,
                                          java.lang.String warehouseID)
                                   throws com.worldpac.dca.ServerException
Set shipping service. Set the shipping service for an order line or an entire order.

Parameters:
partnerID - Partner identifier
orderID - Worldpac order identifier. Obtained by building an order using the fulfillment package and calling Order.getOrderID().
userData - The userData that was provided when the order was created. For verification.
line - Worldpac order line number to deliver via the service specified in shippingServiceID. If 0, set the entire order to the selected shipping service.
shippingServiceID - Worldpac shipping service identifier
warehouseID - Worldpac warehouse identifier. This will always be available in the ShippingOption object where shippingServiceID was found.
Returns:
An updated Shipping object containing details of the shipping options currently selected for the order.
com.worldpac.dca.ServerException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD