The Product Catalog JSP Templates

The BEA WebLogic Commerce Server provides JavaServer Page (JSP) templates and JSP tags that implement commonly used Web-based Product Catalog features. The Product Catalog JSP templates allow your customers to search for product items or browse through categories to locate items; the JSP tags are used to implement this functionality.

This topic includes the following sections:

Note: In this topic, the environment variable WL_COMMERCE_HOME is used to represent the directory in which you installed the WebLogic Commerce Server software.

Introduction

JSP Templates Overview

The BEA WebLogic Commerce Server provides a number of JSP templates that span the start-to-finish experience for a Web site user who is shopping on your site. There are several sequence paths through the system; the following list outlines one possible path.

On Which JavaServer Page Will My Users Start?

Before you can understand which JavaServer Page your users will open first, it is important to understand how your catalog and order fulfillment system will eventually be deployed. This section introduces that topic, and you can follow along by opening the referenced files in the installed WebLogic Commerce Server directories.

Web Applications

The JSP templates and all the supporting Java packages are configured to run as a Web application on the WebLogic Server. In the commerce directory structure, the config directory contains the following path for each Web application:

/config/wlcsDomain/applications/wlcsApp/defaultWebApp

The wlcsDomain parameter is the domain name for the WebLogic server.

The wlcsApp parameter is the name of your J2EE application.

The webApp parameter is the context name given to the Web application, and is included in the initial part of any URL request to the Web application. It can be either a directory or a Web Archive (.war) file that contains the Web application archive.

The Web application named tools includes all the administration tool JSPs, Java packages, and related files. The Web application named wlcs includes all the catalog and order fulfillment JSPs, Java packages, and related files.

XML Deployment Descriptor Files

All other configuration information for the Web applications is described in each one's XML deployment descriptor files. The WebLogic Commerce Server Web application's web.xml deployment descriptor file resides in the following directory:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ WEB-INF\web.xml (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ WEB-INF/web.xml (UNIX)

Listing 5-1 Setting for Welcome Page in the web.xml File

<!-- Welcome file for the WLCS -->
   <welcome-file-list>
     <!-- This is the entry point to a WLCS site. 
          Change this appropriately -->
          <welcome-file>/index.jsp</welcome-file>
   </welcome-file-list>

For the WebLogic Commerce Server Web application, the index.jsp file resides in the root directory for the application, or in:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ index.jsp (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ index.jsp (UNIX)

commercewf Property Set and DestinationDeterminer

If you open index.jsp with a text editor, you will see that it has a single line of JSP code, as follows:

<%

    response.sendRedirect("/wlcs/application/commercewf");

%>

The WebLogic Commerce Server Web application uses an application initialization property set named commercewf. This property set specifies a DestinationDeterminer property that has the following value:

com.beasys.commerce.webflow.DestinationDeterminer

To see the commercewf property set definition yourself, start by opening the Administration Tools home page at:

http://localhost:7501/tools

Figure 5-1 Property Set Page for commercewf

Notes: The webflow.properties file resides in WL_COMMERCE_HOME.

Listing 5-2 Webflow Processing Leading to the Display main.jsp

# GetTopCategories input processor definition

GetTopCategories.inputprocessor=com.beasys.commerce.ebusiness. catalog.webflow.GetCategoryIP

GetTopCategories.inputprocessor.exception(ProcessingException)= commerce/main.jsp

GetTopCategories.inputprocessor.success=GetTopCategories.pipeline
   .
   .
   .
# GetTopCategories pipeline definition

GetTopCategories.pipeline.exception(PipelineFatalException)= commerce/main.jsp

GetTopCategories.pipeline.success=commerce/main.jsp

Thus, when the initial page is opened in a browser and the URL references the context name for the WebLogic Commerce Server Web application (wlcs), the first JSP that is displayed (already populated with values from the Pipeline) is the main.jsp template.

Note: Although the begin state is only set the first time the page is accessed, the process of obtaining the Product Catalog's top categories is initiated by the Webflow each time a customer attempts to access the home page, as shown in the following webflow.properties statement:

*.jsp.link(home)=GetTopCategories.inputprocessor

Sequence Review and the Browser View

Let's review how these files and parameters are working in sequence to open the initial page of the catalog/order site in a customer's browser:

Note: application/commercewf is a property set name, not a part of the directory structure.

Figure 5-2 Home Page Display for the WLCS Application

http://localhost:7501/wlcs/application/commercewf?origin=main.jsp&event=link(browse)&wlcs_catalog_sourceKey=wlcs_categories&wlcs_ catalog_destinationKey=wlcs_siblings&wlcs_catalog_category_id= D.Tool Sets

Figure 5-3 Resulting URI from main.jsp to browse.jsp in the Tool Sets Category

JavaServer Pages (JSPs)

The WebLogic Commerce Server Web application contains a number of JavaServer Pages (JSPs) that let your customers display a catalog's categories and product items. You can use these pages in their current form, or adapt them to meet your specific needs. This section describes each page in detail.

Figure 5-4 Flow of Catalog JSP Templates

Sample Browser View

Figure 5-5 The main.jsp Template Before User Login

Location in the WebLogic Commerce Server Directory Structure

You can find the main.jsp file at the following location, where WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ commerce\main.jsp (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApps/wlcs/ commerce/main.jsp (UNIX)

Tag Library Imports

The main.jsp template uses Pipeline, Catalog, and the WebLogic Personalization Server's User Management JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="pipeline.tld" prefix="pipeline" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="um.tld" prefix="um" %>

These files reside in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\
WEB-INF (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/
WEB-INF (UNIX)

Java Package Imports

The main.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.*" %>
<%@ page import="com.beasys.commerce.foundation.pipeline.*" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>
<%@ page import="com.beasys.commerce.webflow.tags.WebFlowTagConstants" %>
<%@ page import="com.beasys.commerce.axiom.contact.*" %>
<%@ page import="com.beasys.commerce.ebusiness.customer.*" %>
<%@ page import="com.beasys.commerce.content.ContentHelper"%>

Location in the Default Webflow

The main.jsp template is the first page you or your customers will see upon starting the WebLogic Commerce Server Web application. From this page, customers can browse the store catalog by clicking on a link to a particular category (which loads the browse.jsp template). Customers can also enter keywords and click the Find button to perform a Quick Look-up of a particular product item (which loads the searchresults.jsp template). If the customer is logged into the site, the customer can also choose to log out (which loads a different version of the main.jsp template), view their order history (which loads the orderhistory.jsp template), or view their payment history (which loads the paymenthistory.jsp template).

Included JSP Templates

The following JSP templates are included into the main.jsp template:

Events

Table 5-1 main.jsp Events

Dynamic Data Display

One purpose of the main.jsp template is to decide which version of the left column to display (the one with just the Quick Look-up or the one with links to customer-specific data). This is accomplished on the main.jsp template using a combination of Pipeline JSP tags and the WebLogic Personalization Server's User Management JSP tags.

Table 5-2 main.jsp Pipeline Session Attributes

Listing 5-3 Obtaining the USER_NAME Attribute

<%-- Get the username --%>
<pipeline:getPipelineProperty propertyName="<%= PipelineSessionConstants.USER_NAME %>"
returnName="userName" returnType="String" />

Listing 5-4 Displaying the Left Column of main.jsp

<%-- Get the username. The customer 's profile should have already been loaded --%>
<%-- obtained from the um:getProfile tag in the header.inc --%>

<pipeline:getPipelineProperty propertyName="<%= PipelineSessionConstants.USER_NAME %>" returnName="userName" returnType="String" />

<% if (userName != null && userName.length() != 0) { %>

<p><b>Welcome<br>

<um:getPropertyAsString propertyName="firstName" /> <um:getPropertyAsString propertyName="lastName" /></b></p>

<p>&nbsp;&nbsp;<a href="<%=
	WebflowJSPHelper.createWebflowURL(pageContext, pageContext.getAttribute("AboutFileName") + ".jsp", "link(viewCustomerProfile)", true) %>">View Profile</a></p>

<p>&nbsp;&nbsp;<a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "main.jsp", "link(logout)", true) %>">Logout</a></p>

<div class="mid" align="center">
<img src="<%=WebflowJSPHelper.createGIFURL(request, 
response, "/commerce/images/left_rule.gif")%>" width="120" height="14" align="absmiddle"></div>

<p><b>View History</b></p>

<p>&nbsp;&nbsp;<a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "main.jsp", "link(viewOrderHistory)", true)%>">Orders</a></p>

<p>&nbsp;&nbsp;<a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "main.jsp", "link(viewPaymentHistory)", true) %>">Payments</a></p>

<div class="mid" align="center"><img src="<%=WebflowJSPHelper.createGIFURL(request, response, "/commerce/images/left_rule.gif")%>" width="120" height="14" align="absmiddle"></div>

<% } %>

<%-- End of log-in conditional links. --%>

<%-- Only display Quick Look-up links for pages where FullNav is set to "true" --%>

<% if (pageContext.getAttribute("FullNav").equals("true")) { %>

<%-- Add the Quick Look-up section --%>

<p><b>Quick Look-up:</b></p>

<p>&nbsp;&nbsp;Enter keywords</p>

<%-- The optional CATALOG_VIEW_SIZE parameter allows you to specify the number of items per "view" of results --%>

<input type=hidden name="<%= HttpRequestConstants.CATALOG_VIEW_SIZE %>" value="10">

<p>&nbsp;&nbsp; 

<input type="text" name="<%= HttpRequestConstants.CATALOG_SEARCH_STRING %>" size="9" maxlength="50">

<br>

   

<input type="image" value="Find" border="0" src="<%=com.beasys.commerce.webflow.WebflowJSPHelper.createGIFURL(request, response, "/commerce/images/btn_find.gif")%>"></p>

<div class="mid" align="center">
<img src="<%=WebflowJSPHelper.createGIFURL(request, response, "/commerce/images/left_rule.gif")%>" width="120" height="14" align="absmiddle"></div>

<% } %>

<%-- End of FullNav conditional content --%>

However, the primary purpose of the main.jsp template is to dynamically display Product Catalog data by category. This is accomplished using a combination of Pipeline and Catalog JSP tags.

Table 5-3 main.jsp Pipeline Session Attributes

Listing 5-5 Obtaining the CATALOG_CATEGORY and CATALOG_CATEGORIES Attributes

<%-- Get the top category from the PipelineSession. --%>

<pipeline:getPipelineProperty 
propertyName="<%= PipelineSessionConstants.CATALOG_CATEGORY %>"
returnName="topCategory"
returnType="com.beasys.commerce.ebusiness.catalog.Category"
attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>

<%-- Get the subcategories of the top category from the PipelineSession. --%>

<pipeline:getPipelineProperty
propertyName="<%= PipelineSessionConstants.CATALOG_CATEGORIES %>"
returnName="subcategories"
returnType="com.beasys.commerce.ebusiness.catalog.ViewIterator"
attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>

Listing 5-6 Creating a String with Common Browse Parameters

<p class="head1">Store Catalog</p>
  <ul type="square">

<%-- Declare a String containing common browse parameters --%>

<%! static final String commonParameters = "&" +
HttpRequestConstants.CATALOG_SOURCE_KEY + "=" +
PipelineSessionConstants.CATALOG_CATEGORIES + "&" +
HttpRequestConstants.CATALOG_DESTINATION_KEY + 
"=wlcs_siblings&"; %>

Lastly, the iterateViewIterator Catalog JSP tag is used to iterate through all the categories (one at a time). The context for the page is captured by appending values to the previously established browse parameters, and the getProperty Catalog JSP tag is used to list the name of each category on the main.jsp template.

Listing 5-7 Displaying the Contents of the Product Catalog

<catalog:iterateViewIterator 
iterator="<%=subcategories%>" 
id="currentCategory" 
returnType="com.beasys.commerce.ebusiness.catalog.Category">

<% String browseParameters = commonParameters +  
HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
currentCategory.getKey().getIdentifier(); %>

<li>

<a href="<%=WebflowJSPHelper.createWebflowURL(pageContext, 
"main.jsp", "link(browse)", browseParameters, true) %>">

<catalog:getProperty object="<%=currentCategory%>"
propertyName="Name"/>

</a><br>

</catalog:iterateViewIterator>

Form Field Specification

No form fields are used in the main.jsp template.

browse.jsp Template

In the hierarchical Product Catalog, the browse.jsp template can take on two different forms, both of which are used by customers to browse for product items. These forms are as follows:

Figure 5-9 browse.jsp Template - Power Tools --> Drills Category with Item Summary Display

Sample Browser View

Figure 5-10 The browse.jsp Template

Location in the WebLogic Commerce Server Directory Structure

You can find the browse.jsp file at the following location, where WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ commerce\catalog\browse.jsp (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ commerce/catalog/browse.jsp (UNIX)

Tag Library Imports

The browse.jsp template uses Pipeline and Catalog JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="pipeline.tld" prefix="pipeline" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>

These files reside in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\
WEB-INF (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/
WEB-INF (UNIX)

Java Package Imports

The browse.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.*" %>
<%@ page import="com.beasys.commerce.foundation.pipeline.*" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>

Location in the Default Webflow

The browse.jsp template is displayed (with the included category.jsp template) when a customer clicks on a link for one of the categories shown on the main.jsp template. The browse.jsp template is redisplayed (with different content using the included category.jsp template) each time a customer clicks on a subcategory link. It is also displayed when a customer selects a sibling link from the list above the category. The browse.jsp continues to be displayed until the customer arrives at item summaries (shown by the category.jsp template's included itemsummary.jsp templates). From there, the customer can choose to view more details about an item (which loads the details.jsp template), or add the item to their shopping cart (which loads the shoppingcart.jsp template).

Customers can also still enter keywords and click the Find button to perform a Quick Look-up of a particular product item or category (which loads the searchresults.jsp template). If the customer is logged into the site, the customer can also choose to view their order history (which loads the orderhistory.jsp template), view their payment history (which loads the paymenthistory.jsp template), or log out (which loads the generic version of the main.jsp template).

Included JSP Templates

The following JSP templates are included into the browse.jsp template:

About the Included navigation.jsp Template

The navigation.jsp template (included in the browse.jsp template) is responsible for generating the ancestor category navigation bar that is shown at the top of the page. The navigation.jsp template utilizes Pipeline, Catalog, and the WebLogic Personalization Server's Utility JSP tags to generate this content.

Listing 5-8 Obtaining the CATALOG_CATEGORY Attribute

<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_CATEGORY%>"
 returnName="category"
 returnType="com.beasys.commerce.ebusiness.catalog.Category"
 attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>

Next, the <es> JSP tag (one of the WebLogic Personalization Server Utility JSP tags) is used to ensure that the conditions under which the ancestor category navigation bar is displayed are appropriate. If so, the category's ancestors are obtained from the Pipeline session (again using the getPipelineProperty Pipeline JSP tag).

Listing 5-9 Establishing Conditional Display of the Navigation Bar and Obtaining the Category's Ancestors

<%-- Only output the navigation bar if a current category exists in the PipelineSession --%>

<es:notNull item="<%=category%>">

  <%-- Get the category's ancestors from the PipelineSession --%>

  <pipeline:getPipelineProperty 
   propertyName="<%=PipelineSessionConstants.CATALOG_ANCESTORS%>"
   returnName="ancestors"
   returnType="com.beasys.commerce.ebusiness.catalog.Category[]"
   attributeScope="<%=PipelineConstants.REQUEST_SCOPE%>"/>

Listing 5-10 Generating the Hierarchical Category Navigation Bar

  <%-- Declare a String containing common browse parameters --%>

  <%! static final String commonParameters = "&" +
   HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
   PipelineSessionConstants.CATALOG_CATEGORIES + "&" +
   HttpRequestConstants.CATALOG_DESTINATION_KEY + 
   "=wlcs_siblings&"; %>

  <%-- Iterate through all the category's ancestors, creating a
  browse link for each --%>

  <es:forEachInArray id="ancestor" 
   type="com.beasys.commerce.ebusiness.catalog.Category" 
   array="<%=ancestors%>" counterId="i">

    <%-- Add a link to the main catalog page in the case of the last
    ancestor --%>

      <% if (i.intValue() == 0) { %>
        <p><a href="<%= WebflowJSPHelper.createWebflowURL
        (pageContext, "navigation.jsp", "link(home)", true)
        %>">Home</a>

      <%-- Otherwise, link to the browse page for the current
      ancestor --%>

      <% } else { %>
       <a href="<%= WebflowJSPHelper.createWebflowURL
       (pageContext, "navigation.jsp", "link(browse)",
         commonParameters + HttpRequestConstants.CATALOG_CATEGORY_ID
       + "=" + ancestor.getKey().getIdentifier(), true) %>">

	<catalog:getProperty object="<%=ancestor%>"
        propertyName="Name"/></a>

      <% } %>

      &nbsp;<b>&gt;</b>

  </es:forEachInArray>

<%-- Insert the category name --%>

  <b><font color="#333399">
    <catalog:getProperty object="<%=category%>"   
     propertyName="Name"/>
  </font></b></p>

</es:notNull>

About the Included category.jsp Template

The category.jsp template (included in the browse.jsp template) provides a standardized format for the display of hyperlinked subcategories. In the WebLogic Commerce Server Web application, this format is a simple list. However, you can always modify the template to use a different format.

Listing 5-11 Obtaining the CATALOG_CATEGORY and CATALOG_CATEGORIES Attributes

<%-- Get the current category from the PipelineSession --%>

<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_CATEGORY%>"
 returnName="category"
 returnType="com.beasys.commerce.ebusiness.catalog.Category"
 attributeScope="<%=PipelineConstants.REQUEST_SCOPE%>"/>

<%-- Get the subcategories from the PipelineSession --%>	

<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_CATEGORIES%>"
 returnName="subcategories"
 returnType="com.beasys.commerce.ebusiness.catalog.ViewIterator"
 attributeScope="<%=PipelineConstants.REQUEST_SCOPE%>"/>

Listing 5-12 Generating Browse Parameters and Inserting the Category Name

<%! static final String commonParameters = "&" + 
    HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + 
    PipelineSessionConstants.CATALOG_CATEGORIES + "&" + 
    HttpRequestConstants.CATALOG_DESTINATION_KEY + 
    "=wlcs_siblings&"; %>

<%-- Insert the category name --%>

<table border="0" width="90%" cellpadding="3">

<tr>

    <td align="left">

     <p class="head1"><catalog:getProperty 
     object="<%= category %>" propertyName="Name"/></p>

    </td>

Listing 5-13 Displaying Hyperlinked Subcategories

<center>
<table cellpadding="3" border="0" width="90%">

  <catalog:iterateViewIterator 
   iterator="<%=subcategories%>" 
   id="subcategory" 
   returnType="com.beasys.commerce.ebusiness.catalog.Category">

  <tr><td width="30%" valign="top">
    <p class="tabletext">
    <a href="<%=WebflowJSPHelper.createWebflowURL(pageContext, 
    "category.jsp", "link(browse)", commonParameters +
    HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
    subcategory.getKey().getIdentifier(), true) %>">

    <catalog:getProperty object="<%=subcategory%>"
     propertyName="Name"/></a></p>

  </td></tr>
  </catalog:iterateViewIterator>
</table>
</center>

Listing 5-14 Obtaining Individual Product Items and Setting the View

<pipeline:getPipelineProperty
propertyName="<%= PipelineSessionConstants.CATALOG_ITEMS %>"
returnName="items"
returnType="com.beasys.commerce.ebusiness.catalog.ViewIterator"
attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>
.
.
.
// Goto the correct view within the ViewIterator

String viewIndexString = (String)request.getParameter(HttpRequestConstants.CATALOG_VIEW_INDEX);

if (viewIndexString == null) { viewIndexString = "0"; }

int viewIndex = Math.min(Integer.valueOf(viewIndexString).intValue(), items.getViewCount() - 1);

if (viewIndex > 0) { items.gotoViewAt(viewIndex); }

%>

Adding previous and next navigation

Listing 5-15 Iterating Through and Displaying Product Item Information

<catalog:iterateThroughView
iterator="<%=items%>" id="item"
returnType="com.beasys.commerce.ebusiness.catalog.ProductItem"
viewIndex="<%= viewIndex %>">	

<%-- Add the required parameters for the included JSP to the request --%>

<% request.setAttribute("product_item", item); %>
<% request.setAttribute("details_link", "details"); %>

<%-- Get the summary JSP from the current product item --%>

<catalog:getProperty 
object="<%=item%>" 
propertyName="Jsp" 
getterArgument="<%= new Integer(ProductItem.SUMMARY_DISPLAY_JSP_INDEX) %>"
id="summaryJsp"
returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

<%-- Include the summary JSP --%>

<jsp:include page="<%=summaryJsp.getUrl()%>" flush="true"/>

</catalog:iterateThroughView>

Lastly, the category.jsp template counts the number of itemsummary.jsp files used (the number of items), and inserts a numeric range of items across from the category name. For example, if there are nine items on the page, the category.jsp template inserts "1 - 9" to indicate that the page contains items one through nine. If there are enough items to create more than one page (for example, more than 10 items), the template inserts "previous" and/or "next" hyperlinks to navigate to the previous or next page of items, depending on where the visitor is.

Listing 5-16 Setting Top and Bottom "Previous" and "Next" Links

<%-- Add "Next" and "Previous" top navigation --%>

  <% if (items.size() > 0) { %>

  <td align="right">

<%-- Add "Previous" link --%>

  <% if (items.hasPreviousView()) { %>

<b><a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "category.jsp", "link(browse)", commonParameters + HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + category.getKey().getIdentifier() + "&" + HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + 
(viewIndex - 1), true) %>">Previous</a> | </b>

    <% } %>

    <%-- Add current view indicies --%>

    <% if (items.size() > 1) { %>

<b><%= items.getCurrentView().getFirstIndex() %> - 
<%= items.getCurrentView().getLastIndex() %></b>

    <% } %>

<%-- Add "Next" link --%>

    <% if (items.hasNextView()) { %>

<b> | <a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "category.jsp", "link(browse)", commonParameters + HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + category.getKey().getIdentifier() + "&" + HttpRequestConstants.CATALOG_VIEW_INDEX + "=" + (viewIndex + 1), true) %>">Next</a></b></td>

About the Included itemsummary.jsp Template

The itemsummary.jsp template (included in the category.jsp template) provides a standardized format for the display of specific product items. In the WebLogic Commerce Server Web application, this format contains an image, a link to more details about the item (that is, to the details.jsp template), some brief information about the item, and an Add to Cart button. However, you can always modify the template to use a different format.

Listing 5-17 Obtaining Request Object Parameters and the CATALOG_CATEGORY Attribute

<% ProductItem productItem = 
   (ProductItem)request.getAttribute("product_item"); %>

<% String detailsLink = 
   (String)request.getAttribute("details_link"); %>

<%-- Get the current category from the PipelineSession --%>

<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_CATEGORY%>"
 returnName="category"
 returnType="com.beasys.commerce.ebusiness.catalog.Category"
 attributeScope="<%=PipelineConstants.REQUEST_SCOPE%>"/>

Listing 5-18 Displaying Product Item Information

<%-- Add the small image --%>

<catalog:getProperty object="<%=productItem%>"
 propertyName="Image"
 getterArgument="<%=new Integer(ProductItem.SMALL_IMAGE_INDEX)%>"
 id="smallImage" 
 returnType="com.beasys.commerce.ebusiness.catalog.ImageInfo"/>

<td valign="top">
  <img src="<%=com.beasys.commerce.webflow.WebflowJSPHelper.
   createGIFURL(request, response, smallImage.getUrl())%>" 
   align="left"></td>

<td align="left" valign="top" width="90%">

  <%-- Add the item name and creator --%>
  <%-- Create the details link --%>

  <% String detailsUrl = null; %>
  <es:isNull item="<%=category%>">

    <% detailsUrl = WebflowJSPHelper.createWebflowURL(pageContext,
     "itemsummary.jsp", "link(" + detailsLink + ")", "&" + 
     HttpRequestConstants.CATALOG_ITEM_SKU + "=" + 
     productItem.getKey().getIdentifier() + "&" +
     HttpRequestConstants.DOCUMENT_TYPE + "=" + 
     detailsLink, true); %>

  </es:isNull>

  <es:notNull item="<%=category%>">

     <% detailsUrl = WebflowJSPHelper.createWebflowURL(pageContext,
     "itemsummary.jsp", "link(" + detailsLink + ")", "&" + 
     HttpRequestConstants.CATALOG_ITEM_SKU + "=" + 
     productItem.getKey().getIdentifier() + "&" +
     HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
     category.getKey().getIdentifier() + "&" +
     HttpRequestConstants.DOCUMENT_TYPE + "=" + 
     detailsLink, true); %>

  </es:notNull>

  <div class="tabletext"><b>

<%-- we will fire off a clickProductEvent when the user clicks on the product details to see this product --%>

<productTracking:clickProductEvent 
id="url"
documentId="<%= productItem.getName() %>"
sku="<%= productItem.getKey().getIdentifier() %>" />

<% detailsUrl = detailsUrl + "&" + url; %>

    <a href="<%=detailsUrl%>">
      <catalog:getProperty object="<%=productItem%>"
       propertyName="Name"/>
    </a>

  </b>,

    <catalog:getProperty object="<%=productItem%>" 
     propertyName="Creator"/>

  </div>

  <%-- Add the item price --%>

  <div class="tabletext">

  <b>

    <catalog:getProperty object="<%=productItem%>"
     propertyName="CurrentPrice" id="price"
     returnType="com.beasys.commerce.axiom.units.Money"/>

    <i18n:getMessage messageName="<%= price.getCurrency() %>"/>
    <%= WebflowJSPHelper.priceFormat(price.getValue()) %>

  </b>, Reg.

    <catalog:getProperty object="<%=productItem%>"
     propertyName="Msrp" id="msrp"
     returnType="com.beasys.commerce.axiom.units.Money"/>

    <i18n:getMessage messageName="<%= msrp.getCurrency() %>"/>
    <%= WebflowJSPHelper.priceFormat(msrp.getValue()) %>

  </b></div>

<%-- Add inventory information --%>

  <catalog:getProperty object="<%=productItem%>"
  propertyName="Availability" id="inventory"
  returnType="com.beasys.commerce.ebusiness.catalog.InventoryInfo"
  />

  <div class="tabletext"><b>

    <% if (inventory.getInStock()) { %>
      In stock (<%=inventory.getShippingTime()%>)
    <% } else { %>
      Out of stock.
    <% } %>

  </b></div>

<%-- Add a short description of the item --%>

  <br>

  <div class="tabletext">

    <catalog:getProperty object="<%=productItem%>"
     propertyName="Description"
     getterArgument="<%=new Integer
     (CatalogItem.SHORT_DESCRIPTION_INDEX)%>"/>

  </div>

<%-- Add the 'Add to Cart' link --%>

  <div align="right">

    <a href="<%=WebflowJSPHelper.createWebflowURL(pageContext, 
     "itemsummary.jsp", "link(add)", 		"&" + 
     HttpRequestConstants.CATALOG_ITEM_SKU + "=" + 
     productItem.getKey().getIdentifier(), true) %>">
     <img src="<%=com.beasys.commerce.webflow.WebflowJSPHelper.
     createGIFURL(request, response, "/commerce/images/
     btn_addcart.gif")%>" alt="Add To Shopping Cart" border="0" 
     vspace="4"></a>

  </div>

</td>

Events

Table 5-4 browse.jsp (and included category.jsp) Events

Table 5-5 itemsummary.jsp Events

Dynamic Data Display

Table 5-6 browse.jsp Pipeline Session Attributes

Listing 5-19 Obtaining the CATALOG_CATEGORY and wlcs_siblings Attributes

<%-- Get the current category --%>

<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_CATEGORY%>"
 returnName="category"
 returnType="com.beasys.commerce.ebusiness.catalog.Category"
 attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>
.
.
.

<%-- Get the siblings from the PipelineSession --%>

<pipeline:getPipelineProperty 
 propertyName="wlcs_siblings" 
 returnName="siblings"
 returnType="com.beasys.commerce.ebusiness.catalog.ViewIterator"
 attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>

Listing 5-20 Establishing Common Browse Parameters and Creating Browse Links for Categories

<%-- Declare a String containing common browse parameters --%>

<%! static final String commonParameters = "&" +
HttpRequestConstants.CATALOG_SOURCE_KEY + "=" + PipelineSessionConstants.CATALOG_CATEGORIES + "&" +
HttpRequestConstants.CATALOG_DESTINATION_KEY + "=wlcs_siblings&"; %>

<%-- Iterate through all siblings, creating a browse link for each. --%>

<catalog:iterateViewIterator iterator="<%=siblings%>" id="sibling" 
 returnType="com.beasys.commerce.ebusiness.catalog.Category">

<%-- Just highlight the category name if the current sibling is the current category --%>

<% if (sibling.getKey().equals(category.getKey())) { %>
  <p><b><font color="#333399">
  <catalog:getProperty object="<%=sibling%>" propertyName="Name"/>
  </font></b></p>

<% } else { %>

<%-- Otherwise, link to the browse page for the current sibling --%>

  <p><a href="<%=WebflowJSPHelper.createWebflowURL(pageContext,
  "browse.jsp", "link(browse)", commonParameters +
  HttpRequestConstants.CATALOG_CATEGORY_ID + "=" + 
  sibling.getKey().getIdentifier(), true) %>">

  <catalog:getProperty object="<%=sibling%>" 
   propertyName="Name"/></a></p>

<% } %>

</catalog:iterateViewIterator>

Form Field Specification

No form fields are used in the browse.jsp template, nor in the browse.jsp template's included category.jsp or itemsummary.jsp templates.

details.jsp Template

The brief description presented for each product item on the generated itemsummary.jsp templates includes a hyperlink to the item. When customers click this link, the browser loads the details.jsp template, which customer can use to view more detailed information about the item. Although the WebLogic Commerce Server Web application presents the same information on the itemsummary.jsp template and the details.jsp template, you can use this page separation to customize the content for your customers.

Because the name of the detailed display JSP is loaded from the database (that is, it does not have to always be details.jsp), you can have different display JSPs for different Product Catalog items. For example, you can provide custom display JSPs to include seasonal or promotional text. The Product Catalog administrator simply needs to switch between the detailed display JSPs (once they have been tested) using the Administration Tools.

Sample Browser View

Figure 5-11 The details.jsp Template

<%@ include file="/commerce/includes/header.inc" %>

Location in the WebLogic Commerce Server Directory Structure

You can find the details.jsp file at the following location, where WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ commerce\catalog\details.jsp (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ commerce/catalog/details.jsp (UNIX)

Tag Library Imports

The details.jsp template uses Pipeline and Catalog JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="pipeline.tld" prefix="pipeline" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="productTracking.tld" prefix="productTracking" %>

These files reside in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ WEB-INF (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ WEB-INF (UNIX)

Java Package Imports

The details.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.*" %>
<%@ page import="com.beasys.commerce.foundation.pipeline.*" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>
<%@ page import="com.bea.commerce.ebusiness.tracking.events. DisplayProductEvent" %>

Location in the Default Webflow

The details.jsp template is displayed when a customer clicks on a link for a particular product item shown on an itemsummary.jsp template (part of the browse.jsp or search.jsp templates). From the details.jsp template, the customer can choose to browse back up the ancestor category navigation bar (which loads the browse.jsp template) or add the product item to their shopping cart (which loads the shoppingcart.jsp template).

Included JSP Templates

The following JSP templates are included into the details.jsp template:

About the Included itemdetails.jsp Template

Events

Every time a customer clicks a link or button on a JSP, it is considered an event. Events trigger particular responses in the default Webflow that allow customers to continue. While this response can be to load another JSP, it is usually the case that an input processor and/or Pipeline is invoked first.

Table 5-7 itemdetails.jsp Events

Dynamic Data Display

Table 5-8 details.jsp Pipeline Session Attributes

Listing 5-21 Obtaining the CATALOG_CATEGORY and CATALOG_CATEGORIES Attributes

<%-- Get the item from the PipelineSession --%>

<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_ITEM%>"
 		returnName="item"
 		returnType="com.beasys.commerce.ebusiness.catalog.ProductItem"
 		attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>

	<%-- Get the category from the PipelineSession --%>

	<pipeline:getPipelineProperty 
 propertyName="<%=PipelineSessionConstants.CATALOG_CATEGORY%>"
 		returnName="category"
 		returnType="com.beasys.commerce.ebusiness.catalog.Category"
 		attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>"/>		

	<%-- Add the required parameters for the included JSP to the request --%>

	<% request.setAttribute("product_item", item); %>
	<% request.setAttribute("category", category); %>

<%-- Get the summary JSP from the current product item --%>

<catalog:getProperty object="<%=item%>" 
 propertyName="Jsp" 
 getterArgument="<%=new Integer(ProductItem.DETAILED_DISPLAY_JSP_INDEX)%>" 
 id="detailJsp"
 returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

Form Field Specification

No form fields are used in the details.jsp template, nor in the details.jsp template's included itemdetails.jsp template.

search.jsp

The search.jsp template displays a form field that allows users to perform advanced searches on the Product Catalog. Searches are performed using Boolean expressions; results are displayed below the search area, using included summary JSPs.

Notes: It is not expected that end users will search a Product Catalog using a free form, text-based query syntax. The free form syntax input field is provided to illustrate the power of the search functionality. You should customize the search.jsp template to include drop-down lists with the attributes that are appropriate for your business or product items. For example, companies selling books might have edit fields that correspond to Author Name, ISBN, Price, and so on. The contents of these fields would then be converted into a search expression and passed to the catalog system for processing.

Sample Browser View

Figure 5-12 The search.jsp Template

<%@ include file="/commerce/includes/header.inc" %>

Location in the WebLogic Commerce Server Directory Structure

You can find the search.jsp file at the following location, where WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ commerce\catalog\search.jsp (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ commerce/catalog/search.jsp (UNIX)

Tag Library Imports

The search.jsp template uses Pipeline, Catalog, and WebLogic Server JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="pipeline.tld" prefix="pipeline" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="weblogic.tld" prefix="wl" %>

These files reside in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ WEB-INF (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ WEB-INF (UNIX)

Java Package Imports

The search.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.*" %>
<%@ page import="com.beasys.commerce.foundation.pipeline.*" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>

Location in the Default Webflow

The search.jsp template is displayed any time a customer clicks the Search button located in the top banner of most pages. When a Boolean search is submitted, the search.jsp template is reloaded (with included itemsummary.jsp templates for each resulting item). From any of the included itemsummary.jsp templates, customers can view details about the item (which loads the details.jsp template) or add the item to their shopping cart (which loads the shoppingcart.jsp template). Because search results are viewed in groups of 10 by default, the customer may also be able to click Previous/Next links that reload the search.jsp template with new content.

Included JSP Templates

The following JSP templates are included into the search.jsp template:

Events

Table 5-9 search.jsp Events

Note: The NewSearch input processor and Pipeline are not triggered by an event on the search.jsp template. Rather, they are executed when customers click the Search button in the top banner. These mechanisms reset the search results prior to display of the search.jsp template.

Table 5-10 itemsummary.jsp Events

Dynamic Data Display

One purpose of the search.jsp template is to present customers with information about the product items that resulted from their search, which customers can then browse. This is accomplished using a combination of Pipeline and Catalog JSP tags.

Table 5-11 search.jsp Pipeline Session Attributes

Listing 5-22 Obtaining the CATALOG_SEARCH_RESULTS Attribute

<pipeline:getPipelineProperty 
propertyName="<%=PipelineSessionConstants.CATALOG_SEARCH_RESULTS%>"
returnName="results"
returnType="com.beasys.commerce.ebusiness.catalog.ViewIterator" />
attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>" />

Listing 5-23 Setting the View of the Search Results

<% if (results != null && results.size() > 0) { %>
   <%-- Goto the correct view within the ViewIterator --%>
   <% String viewIndexString =
   (String)request.getParameter(HttpRequestConstants.CATALOG_VIEW_INDEX); %>

   		<% if (viewIndexString == null) { viewIndexString = "0"; } %>
      		<% int viewIndex = Math.min(Integer.valueOf(viewIndexString).intValue(),
      results.getViewCount() - 1); %>
      		<% results.gotoViewAt(viewIndex); %>

Listing 5-24 Generating the View Navigation Bar

<!-- Add search results navigation bar -->
<table border="0" width="90%">
<tr>

<td align="left" valign="top"><p class="head2">Results of your search</p>			</td>

			<td align="right" valign="bottom">
  <p class="tabletext">
<b>
			  <%-- Add previous link --%>

  			<% if (results.hasPreviousView()) { %>
     <a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "search.jsp",
     "link(search)",				"&" + HttpRequestConstants.CATALOG_VIEW_INDEX + "=" +
     (viewIndex - 1), true) %>">Previous</a> |
  			<% } %>

  			<%-- Add current view indicies --%>

  			<% if (results.size() > 1) { %>
    			<%= results.getCurrentView().getFirstIndex() %> - <%= results.
    getCurrentView().getLastIndex() %>
  			<% } %>

			  <%-- Add next link --%>

  			<% if (results.hasNextView()) { %>
    			| <a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, "search.jsp", 
    "link(search)",				"&" + HttpRequestConstants.CATALOG_VIEW_INDEX + "=" +
   (viewIndex + 1), true) %>">Next</a>
  			<% } %>

</b>
</td>
</tr>
</table>

Listing 5-25 Obtaining and Displaying the Product Item Summaries

<%-- Iterate through the items in the current view, including the summary JSP for each --%>

		<catalog:iterateThroughView iterator="<%=results%>" id="item" 
 returnType="com.beasys.commerce.ebusiness.catalog.ProductItem" 
 viewIndex="<%= viewIndex %>">

   			<%-- Add the required parameters for the included JSP to the request --%>

   			<% request.setAttribute("product_item", item); %>
   			<% request.setAttribute("details_link", "itemdetails"); %>

   			<%-- Get the summary JSP from the current product item --%>

   			<catalog:getProperty object="<%=item%>" 				propertyName="Jsp"
    				getterArgument="<%= new Integer(ProductItem.SUMMARY_DISPLAY_JSP_INDEX) %>"
    				id="summaryJsp"
    				returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

   			<%-- Included the summary JSP --%>

   			<jsp:include page="<%= summaryJsp.getUrl() %>" flush="true"/>

		</catalog:iterateThroughView>

Form Field Specification

The primary purpose of the search.jsp template is to allow customers to enter their search criteria into an HTML form field. It is also used to pass needed information to the Webflow.

Table 5-12 search.jsp Form Fields

Note: Parameters that are literals in the JSP code are shown in quotes, while non-literals will require scriptlet syntax (such as
<%= HttpRequestConstants.CATALOG_VIEW_SIZE %>) for use in the JSP.

searchresults.jsp

The searchresults.jsp template displays results from a keyword search that is launched from the Quick Look-up text field. The Quick Look-up is available in the left-side column of any page on the site.

Sample Browser View

Figure 5-14 The searchresults.jsp Template

<%@ include file="/commerce/includes/header.inc" %>

Location in the WebLogic Commerce Server Directory Structure

You can find the searchresults.jsp file at the following location, where WL_COMMERCE_HOME is the directory in which you installed WebLogic Commerce Server:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ commerce\catalog\searchresults.jsp (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ commerce/catalog/searchresults.jsp (UNIX)

Tag Library Imports

The searchresults.jsp template uses Pipeline, Catalog, and the WebLogic Personalization Server Utility JSP tags. Therefore, the template includes the following JSP tag libraries:

<%@ taglib uri="pipeline.tld" prefix="pipeline" %>
<%@ taglib uri="cat.tld" prefix="catalog" %>
<%@ taglib uri="es.tld" prefix="es" %>

These files reside in the following directory for the WebLogic Commerce Server Web application:

%WL_COMMERCE_HOME%\config\wlcsDomain\applications\wlcsApp\wlcs\ WEB-INF (Windows)
$WL_COMMERCE_HOME/config/wlcsDomain/applications/wlcsApp/wlcs/ WEB-INF (UNIX)

Java Package Imports

The searchresults.jsp template uses Java classes in the following packages and therefore includes these import statements:

<%@ page import="com.beasys.commerce.webflow.*" %>
<%@ page import="com.beasys.commerce.foundation.pipeline.*" %>
<%@ page import="com.beasys.commerce.ebusiness.catalog.*" %>

Location in the Default Webflow

Customers arrive at the searchresults.jsp template after they enter a keyword in the Quick Look-up text field (located in the left-side column of every page) and click the Find button. From here, customers can navigate back to the main.jsp template using the Home link at the top of the page. Customers can also choose to view more details about a particular item shown in the results list (which loads the details.jsp template), or add the product item to their shopping cart (which loads the shoppingcart.jsp template). Finally, customers can also choose to perform another search by using the Quick Look-up again.

Included JSP Templates

The following JSP templates are included into the searchresults.jsp template:

Events

Table 5-13 searchresults.jsp Events

Table 5-14 itemsummary.jsp Events

Dynamic Data Display

The primary purpose of the searchresults.jsp template is to present customers with information about the product items that resulted from their search, which customers can then browse through. This is accomplished using a combination of Pipeline and Catalog JSP tags.

Table 5-15 searchresults.jsp Pipeline Session Attributes

Listing 5-26 Obtaining the CATALOG_QUERY and CATALOG_SEARCH_RESULTS Attributes

<pipeline:getPipelineProperty 
 propertyName="<%= PipelineSessionConstants.CATALOG_QUERY %>"
 returnName="query"
 returnType="com.beasys.commerce.ebusiness.catalog.service.query.KeywordQuery"/>

<pipeline:getPipelineProperty 
 propertyName="<%= PipelineSessionConstants.CATALOG_SEARCH_RESULTS %>"
 returnName="results"
 returnType="com.beasys.commerce.ebusiness.catalog.ViewIterator"
 attributeScope="<%= PipelineConstants.REQUEST_SCOPE %>" />

Listing 5-27 Constructing the Top Navigation Bar

<p>
<a href="<%= WebflowJSPHelper.createWebflowURL(pageContext, 
 "searchresults.jsp", "link(home)", true) %>">Home</a>

&nbsp;<b>&gt;</b>

<b>
<font color="#9C77DE">Result of search for "

  <es:forEachInArray id="keyword" type="java.lang.String" 
   array="<%= query.getKeywords() %>">
     <%= " " + keyword %>
  </es:forEachInArray>"
  - <%= results.size() %> match<% if (results.size() > 1 ||
  results.size() == 0) { %>es<% } %>

</font>
</b>
</p>

<hr size="1" width="90%" align="left">

Listing 5-28 Setting the View of the Search Results

<!-- Found items are summarized here -->
<% if (results != null && results.size() > 0) { %>
   <%-- Goto the correct view within the ViewIterator --%>
   <% String viewIndexString =
   (String)request.getParameter(HttpRequestConstants.CATALOG_VIEW_INDEX); %>

   		<% if (viewIndexString == null) { viewIndexString = "0"; } %>
      		<% int viewIndex = Math.min(Integer.valueOf(viewIndexString).intValue(),
      results.getViewCount() - 1); %>
      		<% results.gotoViewAt(viewIndex); %>

Listing 5-29 Generating the View Navigation Bar

<table border="0" width="90%">
<tr>

<td align="left" valign="top"><p class="head2">Results of your search</p>			</td>

			<td align="right" valign="bottom">
  <p class="tabletext">			<b>

			  <%-- Add previous link --%>

  			<% if (results.hasPreviousView()) { %>
     <a href="<%= WebflowJSPHelper.createWebflowURL(pageContext,
     "searchresults.jsp", "link(quicksearch)",				"&" +
     HttpRequestConstants.CATALOG_VIEW_INDEX + "=" +
     (viewIndex - 1), true) %>">Previous</a> |
  			<% } %>

  			<%-- Add current view indicies --%>

  			<% if (results.size() > 1) { %>
    			<%= results.getCurrentView().getFirstIndex() %> - <%= results.
    getCurrentView().getLastIndex() %>
  			<% } %>

			  <%-- Add next link --%>

  			<% if (results.hasNextView()) { %>
    			| <a href="<%= WebflowJSPHelper.createWebflowURL(pageContext,
    "searchresultsjsp", "link(quicksearch)",				"&" +
    HttpRequestConstants.CATALOG_VIEW_INDEX + "=" +
    (viewIndex + 1), true) %>">Next</a>
  			<% } %>

			</b>
</td>
</tr>
</table>

Listing 5-30 Obtaining and Displaying the Product Item Summaries

<%-- Iterate through the items in the current view, including the summary JSP for each --%>

		<catalog:iterateThroughView iterator="<%=results%>" id="item" 
 returnType="com.beasys.commerce.ebusiness.catalog.ProductItem" 
 viewIndex="<%= viewIndex %>">

   			<%-- Add the required parameters for the included JSP to the request --%>

   			<% request.setAttribute("product_item", item); %>
   			<% request.setAttribute("details_link", "itemdetails"); %>

   			<%-- Get the summary JSP from the current product item --%>

   			<catalog:getProperty object="<%=item%>" propertyName="Jsp"
    				getterArgument="<%= new Integer(ProductItem.SUMMARY_DISPLAY_JSP_INDEX) %>"
    				id="summaryJsp"
    				returnType="com.beasys.commerce.ebusiness.catalog.JspInfo"/>

   			<%-- Included the summary JSP --%>

   			<jsp:include page="<%= summaryJsp.getUrl() %>" flush="true"/>

		</catalog:iterateThroughView>

Form Field Specification

No form fields are used in the searchresults.jsp template.

Query-Based Search Syntax

Search queries within the BEA WebLogic Commerce Server product use a syntax similar to the SQL string syntax that supports basic Boolean-type comparison expressions, including nested parenthetical queries. In general, the syntax includes a metadata property name, a comparison operator, and a literal value.

The basic query uses the following syntax:

attribute_name comparison_operator literal_value

Several constraints apply to queries constructed using this syntax:

Notes: The query syntax can only contain ASCII and extended ASCII characters (0-255).

Use ExpressionHelper.toStringLiteral to convert an arbitrary string to a fully quoted and escaped string literal, which can then be placed in a query.

The following examples illustrate full expressions:

Example 1:

((color=`red' && size <=1024) || (keywords contains `red' && creationDate < now))

Example 2:

creationDate > toDate (`MM/dd/yyyy HH:mm:ss', `2/22/2000 14:51:00') && expireDate <= now && mimetype like `text/*'

Using Comparison Operators to Construct Queries

To support advanced searching, the system allows construction of nested Boolean queries incorporating comparison operators. The following table summarizes the comparison operators available for each metadata type.

Note: The search parameters and expression objects support negation (using !) of expressions via a bit flag.

Searchable Catalog Attributes

You can base your searches on the following attributes of the Product Catalog:

Note: Some of the attributes have several aliases (for example, shortDesc and shortDescription, lang and language) but refer to a single attribute.

Controlling the Number of Search Results

The number of items returned from a keyword- or attribute-based search is controlled using the following APIs:

These are methods on the com.beasys.commerce.ebusiness.catalog.service.query.KeywordQuery and ProductItemQuery interfaces.

If an unlimited number of search results is desired, use:

setMaxSearchResults( CatalogQuery.ALL_RESULTS );

Limiting the number of search results returned prevents potentially very large result sets from being moved from the database to the JSP container. If the search query name like '*' is executed, all the items in the database will be returned. It may be desirable to limit the size of the result set to a suitably large number such as 1,000.

Listing 5-31 Using the wlcs-catalog.properties File to Control the Default Search Result Size

###############################################################################
#   Maximum search results returned by the catalog
#
#   You can dynamically change the searchresults by using the 
#   get/set MaxSearchResults methods on the CatalogQuery object
#
#   Set the value to -1 to return all results by the search engine
###############################################################################
catalog.searchresults.size=-1

Input Processors

This section provides a brief description of each input processor associated with the Product Catalog JSP templates.

CatalogIP

GetProductItemIP

GetCategoryIP

KeywordSearchIP

ExpressionSearchIP

MoveAttributeIP

RemoveAttributeIP

Pipeline Components

This section provides a brief description of each Pipeline component associated with the Product Catalog JSP templates.

CatalogPC

GetCategoryPC

GetProductItemPC

GetParentPC

GetAncestorsPC

GetProductItemsPC

GetSubcategoriesPC

MoveAttributePC

RemoveAttributePC

SearchPC