Pipelet SearchProductLists
Searches for ProductLists matching the specified input parameters. This is useful in the storefront so customers can search for a product list such as a gift registry by the registrant name. The pipelet can be configured to search for only public product lists or all product lists, though the former is the appropriate option for the storefront. All input parameters are optional. If no input parameters are specified, then an empty collection iterator is returned. If a value is passed for an input parameter, the system performs a search on all product lists in the current site which the passed parameter value on that field. For string fields EventName, RegistrantFirstName, RegistrantLastName, OwnerFirstName, OwnerLastName, and OwnerEmail, the search is implicitly a wildcard search and is case-insensitive. Therefore, if the registrant of a product list has first name "John", this list will be matched by a search on the RegistrantFirstName field using values "John", "john", "Joh", "joh", or even "joh*". Values "ohn" and "*ohn" will not match. It is also possible to search by event date. If a value is passed for the EventDate parameter, an exact date match is required. Alternatively, it is possible to search by date range using EventMonth and EventYear. Searches by location are possible using EventCity, EventState, and EventCountry. These searches do not use wildcards and must match exactly. If values are passed for multiple parameters, they are joined together logically using an AND query (i.e. all criteria must be met). This pipelet is intended to be used in storefront, not in batch jobs. To lookup specific product lists by ID, use ProductListMgr instead of this pipelet.
Group:
ProductList
Configuration Properties
PublicOnly  :  Boolean (Required)
Specifies whether only public or non-public product lists will be found. Default is public.
Permissible Values:
false
true
Input Parameters
EventType  :  String (Optional)
The event type.
EventDate  :  Date (Optional)
The event date.
EventCity  :  String (Optional)
The event city.
EventState  :  String (Optional)
The event state.
EventCountry  :  String (Optional)
The eventy country.
RegistrantFirstName  :  String (Optional)
The first name of the registrant. The registrant name is not necessarily the owner of the product list. For example, a person (owner or customer) could create a product list on behalf of another person (registrant).
RegistrantLastName  :  String (Optional)
The last name of the registrant. The registrant name is not necessarily the owner of the product list. For example, a person (owner or customer) could create a product list on behalf of another person (registrant).
Type  :  Integer (Optional)
The type of ProductList to search for. Possible values are defined as static constants on ProductList, e.g. dw.customer.ProductList.TYPE_WISH_LIST. If no type is provided, this pipelet will search for all types of ProductLists.
EventMonth  :  Integer (Optional)
The event month.
EventYear  :  Integer (Optional)
The event year. If event month is specified and event year is not, the current year is used.
OwnerFirstName  :  String (Optional)
The first name of the owner of the product list. The owner is different than the registrant in that a customer can create a product list on behalf of another person (the registrant).
OwnerLastName  :  String (Optional)
The last name of the owner of the product list. The owner is different than the registrant in that a customer can create a product list on behalf of another person (the registrant).
OwnerEmail  :  String (Optional)
The email address of the owner of the product list. The owner is different than the registrant in that a customer can create a product list on behalf of another person (the registrant).
EventName  :  String (Optional)
The name of the event.
Output Parameters
ProductLists  :  Iterator  :  (Required)
The search results.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.