- abandonedCarts() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- abandonedUnits() - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport.Section
 
-  
 
- abandonedUnits() - Method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
-  
 
- abandonedUnits() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- ad() - Method in class com.apptus.esales.connector.report.AdConversionReport.Section
 
-  
 
- ad() - Method in class com.apptus.esales.connector.report.AdList.Section
 
-  
 
- ad() - Method in class com.apptus.esales.connector.report.AdOrderValueReport.Section
 
-  
 
- ad() - Method in class com.apptus.esales.connector.report.AdPlacementReport.Section
 
-  
 
- Ad - Class in com.apptus.esales.connector.report
 
- 
A class that contains attribute information for an ad.
 
- Ad() - Constructor for class com.apptus.esales.connector.Result.Ad
 
-  
 
- Ad(String) - Constructor for class com.apptus.esales.connector.report.Ad
 
-  
 
- Ad.Attribute - Class in com.apptus.esales.connector.report
 
- 
Class containing name and value for an ad attribute.
 
- adConversion(List<String>, Duration) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- AdConversionReport - Class in com.apptus.esales.connector.report
 
- 
Report for ads.
 
- AdConversionReport(XmlTree, List<AdConversionReport.Section>, TimeInterval, Duration, TimeZone) - Constructor for class com.apptus.esales.connector.report.AdConversionReport
 
- 
Creates an AdConversionReport.
 
- AdConversionReport.Section - Class in com.apptus.esales.connector.report
 
- 
Sub class for AdConversionReport.
 
- add(Duration) - Method in class com.apptus.esales.connector.time.Duration
 
-  
 
- add(String, String...) - Method in class com.apptus.esales.connector.Facets
 
- 
Return a new Facets with the given attribute and values added.
 
- add(String, List<String>) - Method in class com.apptus.esales.connector.Facets
 
- 
Return a new Facets with the given attribute and values added.
 
- add(Calendar, int) - Method in enum com.apptus.esales.connector.time.Unit
 
- 
Moves a calendar amount units in time.
 
- addArgument(String, String) - Method in class com.apptus.esales.connector.Subpanel
 
- 
Adds an argument to the map of arguments for this subpanel,
 where key is the parameter name, and value is the argument value.
 
- addArguments(Map<String, String>) - Method in class com.apptus.esales.connector.Subpanel
 
- 
Appends a map of arguments to the arguments of this subpanel.
 
- addAttribute(String, String) - Method in class com.apptus.esales.connector.report.Ad
 
- 
Adds an attribute to the ad.
 
- addingToCart() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- addProduct(String) - Method in class com.apptus.esales.connector.Order
 
- 
Adds an order line for the specified product and returns the new order line.
 
- addProduct(String) - Method in class com.apptus.esales.connector.SKUList
 
- 
Deprecated.
Add product to the list.
 
- addRange(String, String, String) - Method in class com.apptus.esales.connector.Facets
 
- 
Return a new Facets with the given attribute range added.
 
- addSubpanel(Subpanel) - Method in class com.apptus.esales.connector.DynamicPage
 
- 
Adds a subpanel to this dynamic page.
 
- addTicket(String) - Method in class com.apptus.esales.connector.Order
 
- 
Adds an order line for the variant or product specified by a ticket.
 
- addVariant(String) - Method in class com.apptus.esales.connector.Order
 
- 
Adds an order line for the specified variant and return the new order line.
 
- addVariant(String) - Method in class com.apptus.esales.connector.SKUList
 
- 
Deprecated.
Add a variant to the list without specifying which product it belongs to.
 
- addVariant(String, String) - Method in class com.apptus.esales.connector.Order
 
- 
Adds an order line for the specified variant and return the new order line.
 
- addVariant(String, String) - Method in class com.apptus.esales.connector.SKUList
 
- 
Deprecated.
Add product variant pair to the list.
 
- adList(String, String) - Method in class com.apptus.esales.connector.Reporter
 
- 
Fetches an 
AdList of ads that are active during the selected time range.
 
 
- AdList - Class in com.apptus.esales.connector.report
 
- 
Report for ads containing all ad attributes together with click through rate and conversion rate.
 
- AdList(XmlTree, List<AdList.Section>, TimeInterval, TimeZone) - Constructor for class com.apptus.esales.connector.report.AdList
 
- 
Creates an AdList.
 
- AdList.Section - Class in com.apptus.esales.connector.report
 
- 
Sub class for AdList report.
 
- adOrderValue(List<String>, TimelineType<?>) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- AdOrderValueReport - Class in com.apptus.esales.connector.report
 
- 
Report for ads.
 
- AdOrderValueReport(XmlTree, List<AdOrderValueReport.Section>, TimeInterval, TimelineType<?>, TimeZone) - Constructor for class com.apptus.esales.connector.report.AdOrderValueReport
 
- 
Creates an AdOrderValueReport.
 
- AdOrderValueReport.Section - Class in com.apptus.esales.connector.report
 
- 
Sub class for AdOrderValueReport.
 
- adPlacement(List<String>) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- AdPlacementReport - Class in com.apptus.esales.connector.report
 
- 
Report for ads.
 
- AdPlacementReport(XmlTree, List<AdPlacementReport.Section>, TimeInterval, TimeZone) - Constructor for class com.apptus.esales.connector.report.AdPlacementReport
 
- 
Creates an AdPlacementReport.
 
- AdPlacementReport.Section - Class in com.apptus.esales.connector.report
 
- 
Sub class for AdPlacementReport.
 
- Ads() - Constructor for class com.apptus.esales.connector.Result.Ads
 
-  
 
- ADS - com.apptus.esales.connector.Result.ResultType
 
- 
Ads
 
- allAvailable() - Method in class com.apptus.esales.connector.report.TimelineType
 
-  
 
- amount(Unit) - Method in class com.apptus.esales.connector.time.Duration
 
-  
 
- ancestor(int) - Method in class com.apptus.panel.Path
 
- 
Returns the ancestor of length length of this path.
 
- ancestors() - Method in class com.apptus.panel.Path
 
- 
Returns all the ancestors to a path, starting with the closest.
 
- and(Filter[]) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new AND filter to match the intersection of the results that all filters would return.
 
- and(Filter, Filter, Filter...) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new AND filter to match the intersection of results that q1, q2 and each of the
 filters would return.
 
- aovs() - Method in class com.apptus.esales.connector.report.AdOrderValueReport.Section
 
-  
 
- APRIL - com.apptus.esales.connector.time.Month
 
-  
 
- ArgMap - Class in com.apptus.esales.connector
 
- 
Convenience class for passing arguments to a panel request.
 
- ArgMap() - Constructor for class com.apptus.esales.connector.ArgMap
 
- 
Create a new empty argument map.
 
- atr() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- attribute(String) - Method in class com.apptus.esales.connector.report.Ad
 
-  
 
- attribute(String[], String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new attribute filter, limiting results to products where all processed parts (after tokenization and
 normalization) of the specified value are present within any of the given attributes.
 
- attribute(String, String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new attribute filter, limiting results to products where all processed parts (after tokenization and
 normalization) of the specified value are present within the given attribute.
 
- Attribute(String, String) - Constructor for class com.apptus.esales.connector.Result.Attribute
 
-  
 
- attributes() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns a map of panel attributes and their values.
 
- attributes() - Method in class com.apptus.esales.connector.report.Ad
 
-  
 
- AttributeValidationUtils - Class in com.apptus.esales
 
- 
Simple validation rules for eSales identifiers
 
- AUGUST - com.apptus.esales.connector.time.Month
 
-  
 
- Authorization - Class in com.apptus.esales.connector
 
- 
Deprecated.
 
- Authorization(String, String) - Constructor for class com.apptus.esales.connector.Authorization
 
- 
Deprecated.
 
- availableAdAttributes() - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Gets a list of the names of all ad attributes that has been imported to eSales.
 
- availableAttributeTypes() - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Returns a list of available attribute types from the eSales cluster.
 
- availableCategoryAttributes() - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Gets a list of the names of all category attributes that has been imported to eSales.
 
- availableMarkets() - Method in class com.apptus.esales.connector.Connector
 
- 
Returns a list of available markets from the eSales cluster.
 
- availableProductAttributes() - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Gets a list of the names of all product and variant attributes that has been imported to eSales.
 
- availableScanRules() - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Deprecated.
 
- availableStringRules() - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Deprecated.
 
- averageCampaignConversionRate() - Method in class com.apptus.esales.connector.report.AdConversionReport.Section
 
-  
 
- CalendarDate - Class in com.apptus.esales.connector.time
 
- 
A date on the form YYYY-MM-DD according to the Gregorian calendar.
 
- CalendarDate(Integer, Month, Integer) - Constructor for class com.apptus.esales.connector.time.CalendarDate
 
- 
Creates a new calendar date with the specified year, month and day.
 
- campaignKey() - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Return the campaign key of this ad.
 
- CATEGORY_LIST - com.apptus.esales.connector.Result.ResultType
 
- 
Category List
 
- CATEGORY_TREE - com.apptus.esales.connector.Result.ResultType
 
- 
Category Tree
 
- CategoryList() - Constructor for class com.apptus.esales.connector.Result.CategoryList
 
-  
 
- ceil(Unit, TimeZone, Locale) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Round this time point up to the closest whole unit.
 
- ceil(Calendar) - Method in enum com.apptus.esales.connector.time.Unit
 
- 
Moves the calendar time forwards to the closest whole unit.
 
- checkCustomerDataJobStatus(String) - Method in class com.apptus.esales.connector.Connector
 
- 
Check the status of a GDPR customer data job.
 
- child(String) - Method in class com.apptus.panel.Path
 
- 
Returns a new path denoting a specified child element of the element denoted by this path.
 
- click() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- clicks() - Method in class com.apptus.esales.connector.report.Placement
 
-  
 
- close() - Method in class com.apptus.esales.connector.ProductStreamer
 
-  
 
- CloudConnector - Class in com.apptus.esales.connector
 
- 
Connector for Apptus eSales when hosted in the cloud.
 
- Cluster - Interface in com.apptus.esales.connector
 
- 
Deprecated. 
 
- ClusterUnavailableException - Exception in com.apptus.esales.connector
 
- 
Signals that a cluster operation gave up since no units seem to be able to process the request.
 
- ClusterUnavailableException() - Constructor for exception com.apptus.esales.connector.ClusterUnavailableException
 
- 
Construct a default instance
 
- ClusterUnavailableException(String) - Constructor for exception com.apptus.esales.connector.ClusterUnavailableException
 
-  
 
- ClusterUnavailableException(String, Exception) - Constructor for exception com.apptus.esales.connector.ClusterUnavailableException
 
-  
 
- com.apptus.esales - package com.apptus.esales
 
-  
 
- com.apptus.esales.connector - package com.apptus.esales.connector
 
- 
This package provides utilities for communication with an eSales cluster 
 and this package documentation contains information on how to get started.
 
- com.apptus.esales.connector.report - package com.apptus.esales.connector.report
 
-  
 
- com.apptus.esales.connector.time - package com.apptus.esales.connector.time
 
-  
 
- com.apptus.panel - package com.apptus.panel
 
-  
 
- compareTo(Ad.Attribute) - Method in class com.apptus.esales.connector.report.Ad.Attribute
 
-  
 
- compareTo(CalendarDate) - Method in class com.apptus.esales.connector.time.CalendarDate
 
-  
 
- compareTo(TimePoint) - Method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- compareTo(Path) - Method in class com.apptus.panel.Path
 
-  
 
- Completion() - Constructor for class com.apptus.esales.connector.Result.Completion
 
-  
 
- Completions() - Constructor for class com.apptus.esales.connector.Result.Completions
 
-  
 
- COMPLETIONS - com.apptus.esales.connector.Result.ResultType
 
- 
Auto correction suggestions
 
- connect - Variable in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- Connector - Class in com.apptus.esales.connector
 
- 
Abstract super type for CloudConnector and OnPremConnector.
 
- Connector.ConnectorKey - Class in com.apptus.esales.connector
 
-  
 
- ConnectorKey(String, ExecutorService) - Constructor for class com.apptus.esales.connector.Connector.ConnectorKey
 
-  
 
- ControllerConfigurationException - Exception in com.apptus.esales.connector
 
- 
Deprecated.
 
- conversion() - Method in class com.apptus.esales.connector.report.AdList.Section
 
-  
 
- conversionRate() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchConversion
 
-  
 
- conversionRate() - Method in class com.apptus.esales.connector.report.Summary
 
-  
 
- conversionRateForCampaign() - Method in class com.apptus.esales.connector.report.AdConversionReport.Section
 
-  
 
- conversionRateWithAd() - Method in class com.apptus.esales.connector.report.AdConversionReport.Section
 
-  
 
- conversionRateWithoutAd() - Method in class com.apptus.esales.connector.report.AdConversionReport.Section
 
-  
 
- Correction() - Constructor for class com.apptus.esales.connector.Result.Correction
 
-  
 
- Corrections() - Constructor for class com.apptus.esales.connector.Result.Corrections
 
-  
 
- CORRECTIONS - com.apptus.esales.connector.Result.ResultType
 
- 
Did-you-mean suggestions
 
- count() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchConversion
 
-  
 
- count() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchCount
 
-  
 
- Count() - Constructor for class com.apptus.esales.connector.Result.Count
 
-  
 
- COUNT - com.apptus.esales.connector.Result.ResultType
 
- 
Result count
 
- create(int, Unit) - Static method in class com.apptus.esales.connector.time.Duration
 
-  
 
- create(Duration) - Static method in class com.apptus.esales.connector.report.TimelineType
 
- 
Create a time line type that splits the time into slices of
 a specified duration.
 
- create(Duration, IsoDateTime) - Static method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Creates a time interval with the specified duration ending at 
 the specified end date-time.
 
- create(IsoDateTime, Duration) - Static method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Creates a time interval from the specified start date-time with the
 specified duration.
 
- create(IsoDateTime, IsoDateTime) - Static method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Creates a time interval between the specified start and end 
 date-times.
 
- create(String, String) - Static method in class com.apptus.esales.connector.Subpanel
 
- 
Creates a subpanel with a reference to a public panel.
 
- CREATED - com.apptus.esales.connector.EventDataJobResult.Status
 
-  
 
- createDefault() - Static method in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- createExportCustomerDataJob(String) - Method in class com.apptus.esales.connector.Connector
 
- 
Start a GDPR job on the cluster to export all data related to the given customer key.
 
- createFromUri(ClusterUri) - Static method in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- createRemoveCustomerDataJob(String) - Method in class com.apptus.esales.connector.Connector
 
- 
Start a GDPR job on the cluster to remove all data related to the given customer key.
 
- CssClass - Class in com.apptus.esales.connector
 
- 
Class used to generate the css classes that are required to use automatic notifications or site overlay for web pages.
 
- ctr() - Method in class com.apptus.esales.connector.report.AdList.Section
 
-  
 
- ctr() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- ctr() - Method in class com.apptus.esales.connector.report.Placement
 
-  
 
- ctrs() - Method in class com.apptus.esales.connector.report.AdOrderValueReport.Section
 
-  
 
- customerKey() - Method in class com.apptus.esales.connector.Session
 
-  
 
- CustomerKeyAuthentication - Class in com.apptus.esales.connector
 
- 
A class that should be used for creating personal customer keys when using eSales Web-API.
 
- CustomerKeyAuthentication(String, String) - Constructor for class com.apptus.esales.connector.CustomerKeyAuthentication
 
- 
Creates a new instance that contains a personal customer key and a token, that can be used for
 cross-device client-side notifications in eSales Web API.
 
- empty() - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Return a empty filter representing no results.
 
- end() - Method in class com.apptus.esales.connector.Session
 
- 
Notifies the eSales service that the session has ended.
 
- end(TimeZone) - Method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Returns the end point in time, given the time zone for local
 time.
 
- endOfToday(TimeZone) - Static method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- endpath(int) - Method in class com.apptus.panel.Path
 
- 
Returns an end path of this path.
 
- endTime() - Method in class com.apptus.esales.connector.report.Ad
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.Connector.ConnectorKey
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.Facets
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.Result.Category
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.time.CalendarDate
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.time.Duration
 
- 
True if the argument is a duration with the same or equivalent specification.
 
- equals(Object) - Method in class com.apptus.esales.connector.time.IsoDateTime
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.time.OrdinalDate
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.time.Time
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.time.TimeInterval
 
- 
True if the argument is a time interval specified by the very same
 components as this time interval.
 
- equals(Object) - Method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- equals(Object) - Method in class com.apptus.esales.connector.time.WeekDate
 
-  
 
- equals(Object) - Method in class com.apptus.panel.Path
 
-  
 
- ERROR - com.apptus.esales.connector.EventDataJobResult.Status
 
-  
 
- EventDataJobResult - Class in com.apptus.esales.connector
 
- 
Used to represent the responses from customer data related methods (e.g.
 
- EventDataJobResult.Status - Enum in com.apptus.esales.connector
 
-  
 
- export - Variable in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- exportAds() - Method in class com.apptus.esales.connector.Connector
 
- 
Exports ads from the eSales cluster as a full XML update document.
 
- exportAds(File) - Method in class com.apptus.esales.connector.Connector
 
- 
Exports ads from the eSales cluster as an update file.
 
- exportConfiguration() - Method in class com.apptus.esales.connector.Connector
 
- 
Exports configuration from the eSales cluster as an XML update document.
 
- exportConfiguration(File) - Method in class com.apptus.esales.connector.Connector
 
- 
Exports configuration from the eSales cluster to an update file.
 
- exportPanels() - Method in class com.apptus.esales.connector.Connector
 
- 
Exports panels from the eSales cluster as an XML document.
 
- exportPanels(File) - Method in class com.apptus.esales.connector.Connector
 
- 
Exports panels from the eSales cluster to a definition file.
 
- exportProducts() - Method in class com.apptus.esales.connector.Connector
 
- 
Exports products and categories from the eSales cluster as a full XML update document.
 
- exportProducts(File) - Method in class com.apptus.esales.connector.Connector
 
- 
Exports products and categories from the eSales cluster as a full XML update file.
 
- exportProducts(String, String) - Method in class com.apptus.esales.connector.Connector
 
- 
 
- exportSynonyms() - Method in class com.apptus.esales.connector.Connector
 
- 
Exports synonyms from the eSales cluster as a full XML update document.
 
- exportSynonyms(File) - Method in class com.apptus.esales.connector.Connector
 
- 
Exports synonyms from the eSales cluster as an update file.
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.AdConversionReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.AdList
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.AdOrderValueReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.AdPlacementReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.PanelConversionReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.ProductTopSellersReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.Report
 
- 
Writes the report to a file.
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.SessionStatisticsReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.SessionSummaryReport
 
-  
 
- exportToExcel(File) - Method in class com.apptus.esales.connector.report.TopSellingSearchesReport
 
-  
 
- exportToXml() - Method in class com.apptus.esales.connector.report.Report
 
- 
Returns the XML representation for this report as an input stream.
 
- exportToXml(File) - Method in class com.apptus.esales.connector.report.Report
 
- 
Writes the XML representation for this report to a file.
 
- FACET_LIST - com.apptus.esales.connector.Result.ResultType
 
- 
Facet List
 
- FACET_RANGE - com.apptus.esales.connector.Result.ResultType
 
- 
Facet range
 
- FacetList() - Constructor for class com.apptus.esales.connector.Result.FacetList
 
-  
 
- FacetRange(String, String, String, String) - Constructor for class com.apptus.esales.connector.Result.FacetRange
 
-  
 
- FacetRange(String, String, String, String, String) - Constructor for class com.apptus.esales.connector.Result.FacetRange
 
-  
 
- Facets - Class in com.apptus.esales.connector
 
- 
Class for creating a facets argument, used for check-box navigation.
 
- Facets() - Constructor for class com.apptus.esales.connector.Facets
 
- 
Create a new empty Facets.
 
- Facets(String, String...) - Constructor for class com.apptus.esales.connector.Facets
 
- 
Create a new Facets with the given attribute and values.
 
- Facets(String, List<String>) - Constructor for class com.apptus.esales.connector.Facets
 
- 
Create a new Facets with the given attribute and values.
 
- FEBRUARY - com.apptus.esales.connector.time.Month
 
-  
 
- FetchClusterException - Exception in com.apptus.esales.connector
 
- 
Exception for errors during cluster configuration loading
 
- Filter - Class in com.apptus.esales.connector
 
- 
A convenience class for filters used as argument to selected functions in the eSales service.
 
- Filter() - Constructor for class com.apptus.esales.connector.Filter
 
-  
 
- FilterBuilder - Class in com.apptus.esales.connector
 
- 
A set of static methods for building a filter.
 
- findDescendant(String) - Method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Searches for the specified category key among this category and its descendants.
 
- floor(Unit, TimeZone, Locale) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Round this time point down to the closest whole unit.
 
- floor(Calendar) - Method in enum com.apptus.esales.connector.time.Unit
 
- 
Moves the calendar time backwards to the closest whole unit.
 
- forAddingToCartNotification(String) - Method in class com.apptus.esales.connector.CssClass
 
- 
Converts a ticket to css classes for automatic adding to cart notifications.
 
- forAds() - Static method in class com.apptus.esales.AttributeValidationUtils
 
-  
 
- forCategories() - Static method in class com.apptus.esales.AttributeValidationUtils
 
-  
 
- forClickNotification(String) - Method in class com.apptus.esales.connector.CssClass
 
- 
Converts a ticket to css classes for automatic click notifications.
 
- forClickNotificationAndSiteOverlay(String) - Method in class com.apptus.esales.connector.CssClass
 
- 
Converts a ticket to css classes for automatic click notifications and site overlay.
 
- forProducts() - Static method in class com.apptus.esales.AttributeValidationUtils
 
-  
 
- forSiteOverlay(String) - Method in class com.apptus.esales.connector.CssClass
 
- 
Converts a ticket to css classes needed to use site overlay.
 
- forStartOfQuarter(int) - Static method in enum com.apptus.esales.connector.time.Month
 
- 
Returns the starting month of a quarter.
 
- forSymbol(String) - Static method in enum com.apptus.esales.connector.time.Unit
 
-  
 
- forVariants() - Static method in class com.apptus.esales.AttributeValidationUtils
 
-  
 
- forward(int, Unit, TimeZone) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Equivalent to calling forward(Duration.create(amount, unit), tz).
 
- forward(Duration, TimeZone) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Returns a new time point moved forward the length of a duration.
 
- forward(Calendar) - Method in class com.apptus.esales.connector.time.Duration
 
-  
 
- FRIDAY - com.apptus.esales.connector.time.Weekday
 
-  
 
- fromCalendar(Calendar) - Static method in enum com.apptus.esales.connector.time.Month
 
-  
 
- fromCalendar(Calendar) - Static method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- fromCalendar(Calendar) - Static method in enum com.apptus.esales.connector.time.Weekday
 
-  
 
- fromDate(Date) - Static method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- fromMillis(long) - Static method in class com.apptus.esales.connector.time.Duration
 
-  
 
- fromMillis(long) - Static method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- fromNumber(int) - Static method in enum com.apptus.esales.connector.time.Month
 
-  
 
- fromNumber(int) - Static method in enum com.apptus.esales.connector.time.Weekday
 
-  
 
- fromString(String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new filter, limiting results to products inside the specified filter.
 
- fromString(String, boolean) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new filter, limiting results to products inside the specified filter.
 
- get() - Static method in class com.apptus.esales.connector.CssClass
 
-  
 
- get(String) - Static method in class com.apptus.esales.connector.CloudConnector
 
- 
Gets a connector, provided an eSales cluster URI.
 
- get(String) - Static method in class com.apptus.esales.connector.OnPremConnector
 
- 
Gets a connector, provided a cluster URI.
 
- get(String, ExecutorService) - Static method in class com.apptus.esales.connector.CloudConnector
 
- 
Gets a connector, provided an eSales cluster URI.
 
- get(String, ExecutorService) - Static method in class com.apptus.esales.connector.OnPremConnector
 
- 
Gets a connector, provided a cluster URI and task executor.
 
- getAds() - Method in class com.apptus.esales.connector.Result.Ads
 
- 
Get the list of ads in this result.
 
- getArguments() - Method in class com.apptus.esales.connector.Subpanel
 
-  
 
- getAttribute() - Method in interface com.apptus.esales.connector.Result.Facet
 
- 
The attribute associated with the facet.
 
- getAttribute() - Method in class com.apptus.esales.connector.Result.FacetRange
 
- 
The attribute associated with the range.
 
- getAttribute() - Method in class com.apptus.esales.connector.Result.Values
 
-  
 
- getAttribute(String) - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the attribute with the specified name or null if no such attribute exists for this ad.
 
- getAttribute(String) - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the attribute with the specified name or null if no such attribute exists for this category.
 
- getAttribute(String) - Method in class com.apptus.esales.connector.Result.Product
 
- 
Get the attribute with the specified name or null if no such attribute exists for this product.
 
- getAttribute(String) - Method in class com.apptus.esales.connector.Result.Variant
 
- 
Get the attribute with the specified name or null if no such attribute exists for this variant.
 
- getCategories(String) - Method in class com.apptus.esales.connector.Result.Product
 
- 
Get the category objects of the given category reference attribute.
 
- getCategories(String) - Method in class com.apptus.esales.connector.Result.Variant
 
- 
Get the Category objects of the given category reference attribute.
 
- getCategoryReferenceAttributes() - Method in class com.apptus.esales.connector.Result.Product
 
- 
Get the available category reference attributes in the product.
 
- getCategoryReferenceAttributes() - Method in class com.apptus.esales.connector.Result.Variant
 
- 
Get the available category reference attributes in the product.
 
- getCompletions() - Method in class com.apptus.esales.connector.Result.Completions
 
- 
Get a list of the completions.
 
- getCorrections() - Method in class com.apptus.esales.connector.Result.Corrections
 
- 
Get a list of the corrections.
 
- getCount() - Method in class com.apptus.esales.connector.Result.Count
 
- 
Get the number count.
 
- getCount() - Method in class com.apptus.esales.connector.Result.Value
 
- 
Get the product count associated with this value.
 
- getCustomerKey() - Method in class com.apptus.esales.connector.Authorization
 
- 
Deprecated.
  
- getCustomerKey() - Method in class com.apptus.esales.connector.CustomerKeyAuthentication
 
-  
 
- getDisplayName() - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the display name of this category.
 
- getEndTime() - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the end time or null if no such attribute exists for this ad.
 
- getFacets() - Method in class com.apptus.esales.connector.Result.FacetList
 
- 
Get a list of the facets.
 
- getIncluded() - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the "included" attribute or null if no such attribute exists for this ad.
 
- getJobID() - Method in class com.apptus.esales.connector.EventDataJobResult
 
-  
 
- getLocale() - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the locale of this category.
 
- getMax() - Method in class com.apptus.esales.connector.Result.FacetRange
 
- 
The maximum value for the attribute.
 
- getMaxSelected() - Method in class com.apptus.esales.connector.Result.FacetRange
 
- 
The selected maximum value.
 
- getMin() - Method in class com.apptus.esales.connector.Result.FacetRange
 
- 
The minimum value for the attribute.
 
- getMinSelected() - Method in class com.apptus.esales.connector.Result.FacetRange
 
- 
The selected minimum value.
 
- getName() - Method in class com.apptus.esales.connector.Result.Attribute
 
- 
Get the name of this attribute.
 
- getName() - Method in class com.apptus.esales.connector.Subpanel
 
-  
 
- getOrCreate(String) - Static method in class com.apptus.esales.connector.CloudConnector
 
- 
Creates a connector, unless already created, provided an eSales cluster URI.
 
- getOrCreate(String) - Static method in class com.apptus.esales.connector.OnPremConnector
 
- 
Creates a connector, unless already created, provided a cluster URI.
 
- getOrCreate(String, ExecutorService) - Static method in class com.apptus.esales.connector.CloudConnector
 
- 
Creates a connector, unless already created, provided an eSales cluster URI.
 
- getOrCreate(String, ExecutorService) - Static method in class com.apptus.esales.connector.OnPremConnector
 
- 
Creates a connector, unless already created, provided a cluster URI.
 
- getParent() - Method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Get the parent of this category.
 
- getParentKey() - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the parent key of this category.
 
- getPhrases() - Method in class com.apptus.esales.connector.Result.Phrases
 
- 
Get a list of the phrases.
 
- getProductCount() - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the number of products in this category.
 
- getProducts() - Method in class com.apptus.esales.connector.Result.Ad
 
-  
 
- getProducts() - Method in class com.apptus.esales.connector.Result.Products
 
- 
Get the list of products in this result.
 
- getPublicPanel() - Method in class com.apptus.esales.connector.Subpanel
 
-  
 
- getRank() - Method in class com.apptus.esales.connector.Result.Completion
 
- 
Get the rank of this completion.
 
- getRank() - Method in class com.apptus.esales.connector.Result.Correction
 
- 
Get the rank of the correction.
 
- getRank() - Method in class com.apptus.esales.connector.Result.Phrase
 
- 
Get the rank of the phrase.
 
- getRelated() - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the "related" attribute or null if no such attribute exists for this ad.
 
- getRelevance() - Method in class com.apptus.esales.connector.Result.Completion
 
- 
Get the relevance of this completion.
 
- getRelevance() - Method in class com.apptus.esales.connector.Result.Correction
 
- 
Get the relevance of this correction.
 
- getRelevance() - Method in class com.apptus.esales.connector.Result.Phrase
 
- 
Get the relevance of this phrase.
 
- getRelevance() - Method in class com.apptus.esales.connector.Result.Value
 
- 
Deprecated.
 
- getSelectedSubcategory() - Method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Get the selected category among this category's subcategories.
 
- getStartTime() - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the start time or null if no such attribute exists for this ad.
 
- getStatus() - Method in class com.apptus.esales.connector.EventDataJobResult
 
- 
Get the status.
 
- getStatusString() - Method in class com.apptus.esales.connector.EventDataJobResult
 
- 
 
- getSubcategories() - Method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Get a list of this category's subcategories, if they were included in the result.
 
- getText() - Method in class com.apptus.esales.connector.Result.Completion
 
- 
Get the suggested completion.
 
- getText() - Method in class com.apptus.esales.connector.Result.Correction
 
- 
Get the suggested correction.
 
- getText() - Method in class com.apptus.esales.connector.Result.Phrase
 
- 
Get the suggested phrase.
 
- getText() - Method in class com.apptus.esales.connector.Result.Value
 
- 
Get the text of the value.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the notification ticket of this ad.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the notification ticket of this category.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Completion
 
- 
Get the notification ticket of this completion.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Correction
 
- 
Get the notification ticket of this correction.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Phrase
 
- 
Get the notification ticket of this phrase.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Product
 
- 
Get the notification ticket of this product.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Value
 
- 
Deprecated.
 
- getTicket() - Method in class com.apptus.esales.connector.Result.Variant
 
- 
Get the notification ticket of this variant.
 
- getToken() - Method in class com.apptus.esales.connector.Authorization
 
- 
Deprecated.
  
- getToken() - Method in class com.apptus.esales.connector.CustomerKeyAuthentication
 
-  
 
- getTree() - Method in class com.apptus.esales.connector.Result.CategoryData
 
- 
Get the tree name of this category, which is also the referencing product attribute.
 
- getType() - Method in class com.apptus.esales.connector.Result.Ads
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.CategoryList
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.CategoryNode
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.Completions
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.Corrections
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.Count
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.FacetList
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.FacetRange
 
-  
 
- getType() - Method in interface com.apptus.esales.connector.Result
 
- 
Get the result type of this result.
 
- getType() - Method in class com.apptus.esales.connector.Result.Phrases
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.Products
 
-  
 
- getType() - Method in class com.apptus.esales.connector.Result.Values
 
-  
 
- getValue() - Method in class com.apptus.esales.connector.Result.Attribute
 
- 
Get the value of this attribute.
 
- getValue(String) - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the attribute with the specified name from this ad or null if no such attribute exists.
 
- getValue(String) - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the attribute with the specified name from this category or null if no such attribute exists.
 
- getValue(String) - Method in class com.apptus.esales.connector.Result.Product
 
- 
Get the attribute with the specified name from this product or null if no such attribute exists.
 
- getValue(String) - Method in class com.apptus.esales.connector.Result.Variant
 
- 
Get the attribute with the specified name from this variant or null if no such attribute exists.
 
- getValue(String, String) - Method in class com.apptus.esales.connector.Result.Ad
 
- 
Get the value of the attribute with the specified attributeName.
 
- getValue(String, String) - Method in class com.apptus.esales.connector.Result.Category
 
- 
Get the value of the attribute with the specified attributeName.
 
- getValue(String, String) - Method in class com.apptus.esales.connector.Result.Product
 
- 
Get the value of the attribute with the specified attributeName.
 
- getValue(String, String) - Method in class com.apptus.esales.connector.Result.Variant
 
- 
Get the value of the attribute with the specified attributeName.
 
- getValues() - Method in class com.apptus.esales.connector.Result.Values
 
- 
Get a list of the values.
 
- getVariants() - Method in class com.apptus.esales.connector.Result.Product
 
-  
 
- getVersion() - Static method in class com.apptus.esales.connector.Connector
 
- 
Returns the connector version.
 
- impact() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchConversion
 
-  
 
- importAds(File, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports ads from the specified file to the eSales cluster.
 
- importAds(InputStream, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports ads from the specified stream to the eSales cluster.
 
- importConfiguration(File, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports configuration from the specified file to the eSales cluster.
 
- importConfiguration(InputStream, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports configuration from the specified stream to the eSales cluster.
 
- importFile(String, File, String, Long) - Method in class com.apptus.esales.connector.Connector
 
-  
 
- importPanels(File, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports panels from the specified file to the eSales cluster.
 
- importPanels(InputStream, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports panels of the specified stream to the eSales cluster.
 
- importProducts(File, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports products and categories from the specified file to the eSales cluster.
 
- importProducts(InputStream, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports products and categories of the specified stream to the eSales cluster.
 
- importSynonyms(File, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports synonyms from the specified file to the eSales cluster.
 
- importSynonyms(InputStream, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Imports synonyms from the specified stream to the eSales cluster.
 
- importTimeout - Variable in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- incremental(String[], String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new INCREMENTAL filter, limiting the result to products where all processed parts (after tokenization and
 normalization) of the specified value are present within any of the given attributes.
 
- incremental(String, String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new INCREMENTAL filter, limiting the result to products where all processed parts (after tokenization and
 normalization) of the specified value are present within the given attribute.
 
- InterruptedIterationException - Exception in com.apptus.esales.connector
 
- 
Thrown when an iteration is prematurely interrupted by an exception.
 
- InterruptedIterationException(Exception) - Constructor for exception com.apptus.esales.connector.InterruptedIterationException
 
-  
 
- InterruptedIterationException(String) - Constructor for exception com.apptus.esales.connector.InterruptedIterationException
 
-  
 
- InterruptedIterationException(String, Exception) - Constructor for exception com.apptus.esales.connector.InterruptedIterationException
 
-  
 
- InvalidFilterException - Exception in com.apptus.esales.connector
 
- 
Thrown to signal that an invalid filter was specified using the filter builder.
 
- InvalidFilterException(String) - Constructor for exception com.apptus.esales.connector.InvalidFilterException
 
-  
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.Ads
 
- 
Return true if this result is empty and false otherwise.
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.Completions
 
- 
Check if this result is empty.
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.Corrections
 
- 
Check if this result is empty.
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.FacetList
 
- 
Check if this result is empty.
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.Phrases
 
- 
Check if this result is empty.
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.Products
 
- 
Return true if this result is empty and false otherwise.
 
- isEmpty() - Method in class com.apptus.esales.connector.Result.Values
 
- 
Check if this result is empty.
 
- ISO8601 - Static variable in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- IsoDate - Class in com.apptus.esales.connector.time
 
- 
A date on any valid ISO 8601 format.
 
- IsoDate() - Constructor for class com.apptus.esales.connector.time.IsoDate
 
-  
 
- IsoDateTime - Class in com.apptus.esales.connector.time
 
- 
A date and time on the ISO 8601 format.
 
- IsoDateTime(IsoDate, Time) - Constructor for class com.apptus.esales.connector.time.IsoDateTime
 
- 
Creates a date-object with the specified date and time.
 
- isoDateTimeFormat() - Method in class com.apptus.esales.connector.report.Report
 
-  
 
- isRange() - Method in interface com.apptus.esales.connector.Result.Facet
 
- 
Check if this facet is a range facet or a multi value facet.
 
- isRange() - Method in class com.apptus.esales.connector.Result.FacetRange
 
-  
 
- isRange() - Method in class com.apptus.esales.connector.Result.Values
 
-  
 
- isRoot() - Method in class com.apptus.panel.Path
 
-  
 
- isSelected() - Method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Check if this category is a selected category.
 
- isSelected() - Method in class com.apptus.esales.connector.Result.Value
 
- 
Check if this value is a selected facet value.
 
- isValidToken(String, String, String) - Static method in class com.apptus.esales.connector.Authorization
 
- 
Deprecated.
  
- isZone() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns true if this panel is a container, that is, contains sub panels.
 
- iterator() - Method in class com.apptus.esales.connector.ProductStreamer
 
- 
Closes any previous iterator associated with this ProductStreamer and creates a new iterator.
 
- iterator() - Method in class com.apptus.esales.connector.Result.Ad
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Ads
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Category
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Completions
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Corrections
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.FacetList
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Phrases
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Product
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Products
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Values
 
-  
 
- iterator() - Method in class com.apptus.esales.connector.Result.Variant
 
-  
 
- itr() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- MARCH - com.apptus.esales.connector.time.Month
 
-  
 
- margin() - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport.Section
 
-  
 
- margin() - Method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
-  
 
- margin() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- market() - Method in class com.apptus.esales.connector.Session
 
-  
 
- MAY - com.apptus.esales.connector.time.Month
 
-  
 
- MessageAuthentication - Class in com.apptus.esales.connector
 
- 
A class that is used for signing messages.
 
- MessageAuthentication(String) - Constructor for class com.apptus.esales.connector.MessageAuthentication
 
- 
Creates a new instance with a specific private key, that can then be used to sign messages.
 
- minute() - Method in class com.apptus.esales.connector.time.Time
 
-  
 
- MINUTE - com.apptus.esales.connector.time.Unit
 
-  
 
- MissingSubpanelException - Exception in com.apptus.esales.connector
 
-  
 
- MissingSubpanelException(String) - Constructor for exception com.apptus.esales.connector.MissingSubpanelException
 
-  
 
- mock(int) - Static method in class com.apptus.esales.connector.Result.Count
 
- 
Creates a new Count object for test purposes.
 
- mock(String, EventDataJobResult.Status) - Static method in class com.apptus.esales.connector.EventDataJobResult
 
- 
 
- mock(String, String) - Static method in class com.apptus.esales.connector.Result.Attribute
 
- 
Creates a new Attribute object for test purposes.
 
- mock(String, String, int, double) - Static method in class com.apptus.esales.connector.Result.Completion
 
- 
Creates a new Completion object for test purposes.
 
- mock(String, String, int, double) - Static method in class com.apptus.esales.connector.Result.Correction
 
- 
Creates a new Correction object for test purposes.
 
- mock(String, String, int, double) - Static method in class com.apptus.esales.connector.Result.Phrase
 
- 
Creates a new Phrase object for test purposes.
 
- mock(String, String, int, double, boolean) - Static method in class com.apptus.esales.connector.Result.Value
 
- 
Creates a new Value object for test purposes.
 
- mock(String, String, Result.CategoryNode, String, List<Result.Attribute>, List<Result.Attribute>) - Static method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Creates a new leaf CategoryNode object for test purposes.
 
- mock(String, String, Result.CategoryNode, String, List<Result.Attribute>, List<Result.Attribute>, List<Result.CategoryNode>) - Static method in class com.apptus.esales.connector.Result.CategoryNode
 
- 
Creates a new CategoryNode object with subcategories for test purposes.
 
- mock(String, String, TimePoint, TimePoint, Filter, Filter, String, Result.Products, List<Result.Attribute>) - Static method in class com.apptus.esales.connector.Result.Ad
 
- 
Creates a new Ad object for test purposes.
 
- mock(String, String, String, String, List<Result.Attribute>, List<Result.Attribute>) - Static method in class com.apptus.esales.connector.Result.CategoryData
 
- 
Creates a new CategoryData object for test purposes.
 
- mock(String, String, List<Result.Attribute>) - Static method in class com.apptus.esales.connector.Result.Variant
 
- 
Creates a new Variant object for test purposes.
 
- mock(String, String, List<Result.Attribute>, Map<String, List<Result.CategoryData>>) - Static method in class com.apptus.esales.connector.Result.Variant
 
- 
Creates a new Variant object with category references for test purposes.
 
- mock(String, String, List<Result.Variant>, List<Result.Attribute>) - Static method in class com.apptus.esales.connector.Result.Product
 
- 
Creates a new Product object for test purposes.
 
- mock(String, String, List<Result.Variant>, List<Result.Attribute>, Map<String, List<Result.CategoryData>>) - Static method in class com.apptus.esales.connector.Result.Product
 
- 
Creates a new Product object with category references for test purposes.
 
- mock(List<Result.Ad>) - Static method in class com.apptus.esales.connector.Result.Ads
 
- 
Creates a new Ads object for test purposes.
 
- mock(List<Result.Completion>) - Static method in class com.apptus.esales.connector.Result.Completions
 
- 
Creates a new Completions object for test purposes.
 
- mock(List<Result.Correction>) - Static method in class com.apptus.esales.connector.Result.Corrections
 
- 
Creates a new Corrections object for test purposes.
 
- mock(List<Result.Facet>) - Static method in class com.apptus.esales.connector.Result.FacetList
 
- 
Creates a new FacetList object for test purposes.
 
- mock(List<Result.Phrase>) - Static method in class com.apptus.esales.connector.Result.Phrases
 
- 
Creates a new Phrases object for test purposes.
 
- mock(List<Result.Product>) - Static method in class com.apptus.esales.connector.Result.Products
 
- 
Creates a new Products object for test purposes.
 
- mock(List<Result.Value>) - Static method in class com.apptus.esales.connector.Result.Values
 
- 
Creates a new Values object for test purposes.
 
- mock(List<Result.Value>, String) - Static method in class com.apptus.esales.connector.Result.Values
 
- 
Creates a new Values object for test purposes.
 
- MONDAY - com.apptus.esales.connector.time.Weekday
 
-  
 
- month() - Method in class com.apptus.esales.connector.time.CalendarDate
 
-  
 
- month(int, Month) - Static method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Convenience method for returning a time interval covering a complete
 calendar month.
 
- Month - Enum in com.apptus.esales.connector.time
 
- 
Enumeration of months.
 
- MONTH - com.apptus.esales.connector.time.Unit
 
-  
 
- MONTH_OF_YEAR - Static variable in class com.apptus.esales.connector.report.TimelineType
 
-  
 
- name() - Method in class com.apptus.esales.connector.report.Ad.Attribute
 
-  
 
- name() - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport.Section
 
-  
 
- NaN() - Static method in class com.apptus.esales.connector.report.Rate
 
-  
 
- next(int, Unit, TimeZone, Locale) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Equivalent to calling next(Duration.create(amount, unit), tz, locale).
 
- next(Duration, TimeZone, Locale) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Returns a new time point representing the start of the next period as defined by a duration.
 
- next(Calendar) - Method in class com.apptus.esales.connector.time.Duration
 
- 
Moves the calendar to the next position, as if divided into pieces of time with the length defines by this Duration.
 
- not(Filter) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new NOT filter matching every result that the given operand doesn't match.
 
- NOT_FOUND - com.apptus.esales.connector.EventDataJobResult.Status
 
-  
 
- notification - Variable in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- notify(Connector, String, String, String, String, String, String) - Static method in class com.apptus.esales.connector.JavaScriptNotifier
 
- 
Pass through a JavaScript notification to the cluster.
 
- notify(Connector, String, String, String, String, String, String, String, String) - Static method in class com.apptus.esales.connector.JavaScriptNotifier
 
- 
Deprecated.
 
- notify(String, Map<? extends CharSequence, ? extends CharSequence>) - Method in interface com.apptus.esales.connector.Cluster
 
- 
Deprecated.
Notify the cluster.
 
- notifyAddingToCart(String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a product being added to the shopping cart by a user in the session.
 
- notifyClick(String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a click being made by the user in a session.
 
- notifyFavoriteAddition(String, String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a product being added to favorites.
 
- notifyFavoriteRemoval(String, String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a product being removed from favorites.
 
- notifyNonEsalesAddingToCart(String, String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a non-eSales product being added to the shopping cart by a user in the
 session.
 
- notifyNonEsalesClick(String, String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a non-eSales product click being made by the user in a session.
 
- notifyNonEsalesEvent(Connector, String, String, String, String, String, String, String) - Static method in class com.apptus.esales.connector.JavaScriptNotifier
 
-  
 
- notifyPayment(Order) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about products and variants being paid by a user in the session.
 
- notifyPayment(SKUList) - Method in class com.apptus.esales.connector.Session
 
- 
Deprecated.
 
- notifyPayment(SKUList, double) - Method in class com.apptus.esales.connector.Session
 
- 
Deprecated.
 
- notifyPayment(Iterable<String>) - Method in class com.apptus.esales.connector.Session
 
- 
Deprecated.
 
- notifyPayment(Iterable<String>, double) - Method in class com.apptus.esales.connector.Session
 
- 
Deprecated.
 
- notifyPayment(String) - Method in class com.apptus.esales.connector.Session
 
- 
Deprecated.
 
- notifyPayment(String, double) - Method in class com.apptus.esales.connector.Session
 
- 
Deprecated.
 
- notifyProperty(String, String) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a session property being set.
 Later calls will overwrite the previous values of the property.
 
- notifyRating(String, int) - Method in class com.apptus.esales.connector.Session
 
- 
Sends a notification to the eSales service, about a product being rated.
 
- notifyWithProperties(Connector, String, String, String, String, String, String, String, String) - Static method in class com.apptus.esales.connector.JavaScriptNotifier
 
- 
Pass through a JavaScript notification to the cluster.
 
- NOVEMBER - com.apptus.esales.connector.time.Month
 
-  
 
- now() - Static method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- number() - Method in enum com.apptus.esales.connector.time.Month
 
- 
Returns the ISO 8601 number for this month.
 
- number() - Method in enum com.apptus.esales.connector.time.Weekday
 
-  
 
- panel(String) - Method in class com.apptus.esales.connector.Session
 
- 
Returns a panel specified by the path supplied as argument.
 
- Panel - Class in com.apptus.esales.connector
 
- 
A panel in the eSales panel hierarchy.
 
- PanelContent - Class in com.apptus.esales.connector
 
- 
The content of a panel as retrieved from an eSales service.
 
- panelConversion(String) - Method in class com.apptus.esales.connector.Reporter
 
- 
Deprecated.
 
- PanelConversionReport - Class in com.apptus.esales.connector.report
 
- 
Report for panel performance, one section for each public panel path.
 
- PanelConversionReport(XmlTree, TimeInterval, List<PanelConversionReport.Section>, TimeZone) - Constructor for class com.apptus.esales.connector.report.PanelConversionReport
 
- 
Creates an PanelConversionReport.
 
- PanelConversionReport.Section - Class in com.apptus.esales.connector.report
 
- 
Sub class for PanelConversionReport.
 
- PanelException - Exception in com.apptus.esales.connector
 
- 
Thrown when trying to read the result from a panel, if the evaluation resulted in error in the eSales service.
 
- panelType() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- parent() - Method in class com.apptus.panel.Path
 
- 
Returns a new path denoting the parent element of the element denoted by this path.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.AdConversionReport
 
- 
Creates an AdConversionReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.AdList
 
- 
Creates an AdList from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.AdOrderValueReport
 
- 
Creates an AdOrderValueReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.AdPlacementReport
 
- 
Creates an AdPlacementReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.PanelConversionReport
 
- 
Creates a PanelConversionReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport
 
- 
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
- 
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.ProductTopSellersReport
 
- 
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
- 
Creates an SearchStatisticsReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.SessionStatisticsReport
 
- 
Creates an SessionStatisticsReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.SessionSummaryReport
 
- 
Creates an SessionSummaryReport from an XML document.
 
- parse(XmlScanner, TimeZone) - Static method in class com.apptus.esales.connector.report.TopSellingSearchesReport
 
- 
 
- parse(String) - Static method in class com.apptus.esales.connector.Facets
 
- 
Create a Facets object from the source string.
 
- parse(String) - Static method in class com.apptus.esales.connector.report.TimelineType
 
- 
Parse the specified timelineType.
 
- parse(String) - Static method in class com.apptus.esales.connector.time.Duration
 
- 
Parses a duration.
 
- parse(String) - Static method in class com.apptus.esales.connector.time.IsoDateTime
 
- 
Parses a date and time specification and returns a date-time object.
 
- parse(String) - Static method in class com.apptus.esales.connector.time.Time
 
- 
Parses a time of day in ISO 8601 format and returns it as a Time object.
 
- parse(String) - Static method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Parses a time interval on any of the three valid formats.
 
- parse(String) - Static method in class com.apptus.panel.Path
 
- 
Parses the path supplied as a string and returns a Path object representing the same path.
 
- parse(String, TimeZone) - Static method in class com.apptus.esales.connector.time.TimePoint
 
- 
Parses a date-time specification as defined by ISO 8601 and
 returns a time point valid for the specified date-time.
 
- ParseException - Exception in com.apptus.esales.connector
 
- 
Thrown when a response from the eSales service could not be parsed.
 
- ParseException(String, Exception) - Constructor for exception com.apptus.esales.connector.ParseException
 
-  
 
- parseInContext(String, IsoDateTime) - Static method in class com.apptus.esales.connector.time.IsoDateTime
 
- 
Parses a date and time specification and returns a date-time object.
 
- parseInContext(String, Time) - Static method in class com.apptus.esales.connector.time.Time
 
- 
Parses a time of day in ISO 8601 format and returns it as a Time object.
 
- path - Variable in class com.apptus.panel.Path
 
-  
 
- path() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns the complete path of this panel.
 
- path() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- path() - Method in class com.apptus.esales.connector.report.Placement
 
-  
 
- Path - Class in com.apptus.panel
 
- 
Convenience class for working with panel paths.
 
- Path(String) - Constructor for class com.apptus.panel.Path
 
-  
 
- payment() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- percent(int) - Method in class com.apptus.esales.connector.report.Rate
 
- 
Formats the rate as percentage with decimals number of decimals.
 
- perMille(int) - Method in class com.apptus.esales.connector.report.Rate
 
- 
Formats the rate as per mille with decimals number of decimals.
 
- phrase() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchConversion
 
-  
 
- phrase() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchCount
 
-  
 
- phrase() - Method in class com.apptus.esales.connector.report.TopSellingSearchesReport.Section
 
-  
 
- Phrase() - Constructor for class com.apptus.esales.connector.Result.Phrase
 
-  
 
- Phrases() - Constructor for class com.apptus.esales.connector.Result.Phrases
 
-  
 
- PHRASES - com.apptus.esales.connector.Result.ResultType
 
- 
Phrases
 
- Placement - Class in com.apptus.esales.connector.report
 
- 
A class holding the number of clicks, number of displays and click through rate for a public panel path.
 
- Placement(String, int, int) - Constructor for class com.apptus.esales.connector.report.Placement
 
-  
 
- placements() - Method in class com.apptus.esales.connector.report.AdPlacementReport.Section
 
-  
 
- precision() - Method in class com.apptus.esales.connector.time.Duration
 
-  
 
- Product() - Constructor for class com.apptus.esales.connector.Result.Product
 
-  
 
- productKey() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- Products() - Constructor for class com.apptus.esales.connector.Result.Products
 
-  
 
- PRODUCTS - com.apptus.esales.connector.Result.ResultType
 
- 
Products
 
- productSalesByAttribute(String, Filter, Facets, String) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- productSalesByAttribute(String, Filter, String) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- ProductSalesByAttributeReport - Class in com.apptus.esales.connector.report
 
- 
Report containing sales statistics aggregated by product attribute values during the specified time interval.
 
- ProductSalesByAttributeReport(XmlTree, List<ProductSalesByAttributeReport.Section>, TimeInterval, TimeZone) - Constructor for class com.apptus.esales.connector.report.ProductSalesByAttributeReport
 
- 
 
- ProductSalesByAttributeReport.Section - Class in com.apptus.esales.connector.report
 
- 
 
- productSalesByTime(TimelineType<?>, Filter) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- productSalesByTime(TimelineType<?>, Filter, Facets) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- ProductSalesByTimeReport - Class in com.apptus.esales.connector.report
 
- 
Report containing aggregated sales statistics.
 
- ProductSalesByTimeReport(XmlTree, TimeInterval, Timeline<Double>, Timeline<Integer>, Timeline<Integer>, Timeline<Double>, Timeline<Double>, TimelineType<?>, TimeZone) - Constructor for class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
- 
 
- ProductStreamer - Class in com.apptus.esales.connector
 
- 
 
- productTopSellers(Filter, Facets, String, int, int) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- productTopSellers(Filter, String, int, int) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- ProductTopSellersReport - Class in com.apptus.esales.connector.report
 
- 
Report for products.
 
- ProductTopSellersReport.Section - Class in com.apptus.esales.connector.report
 
- 
 
- ptr() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- purchasedUnits() - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport.Section
 
-  
 
- purchasedUnits() - Method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
-  
 
- purchasedUnits() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- purchasedUnits() - Method in class com.apptus.esales.connector.report.TopSellingSearchesReport.Section
 
-  
 
- purchases() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- purchasesFromRecommendations() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- purchasesFromSearches() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- put(String, Object) - Method in class com.apptus.esales.connector.ArgMap
 
- 
Associates the specified value with the specified key in this map.
 
- putCurrentUnitPrice(double) - Method in class com.apptus.esales.connector.Order.Line
 
- 
Deprecated.
 
- putQuantity(int) - Method in class com.apptus.esales.connector.Order.Line
 
- 
Adds information about the quantity.
 
- putStrings(Map<? extends CharSequence, ? extends CharSequence>, ArgMap) - Method in class com.apptus.esales.connector.Connector
 
-  
 
- putUnitCost(double) - Method in class com.apptus.esales.connector.Order.Line
 
- 
Adds information about the cost (what it costs for the shop to acquire the product, including VAT) for each unit
 to this order line.
 
- putUnitSellingPrice(double) - Method in class com.apptus.esales.connector.Order.Line
 
- 
Adds information about the selling price (the actual price that the customer pays, including VAT
 but excluding delivery costs) for each unit to this order line.
 
- range(String[], String, String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new range filter, limiting results to values between from (inclusive) and to
 (exclusive), for any of the specified attributes.
 
- range(String[], String, String, boolean, boolean) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new range filter limiting results to values between from and to, for any of the
 specified attributes.
 
- range(String, String, String) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new range filter, limiting results to values between from (inclusive) and to
 (exclusive), for the specified attribute.
 
- range(String, String, String, boolean, boolean) - Static method in class com.apptus.esales.connector.FilterBuilder
 
- 
Create a new range filter limiting results to values between from and to, for the specified
 attribute.
 
- rank() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- rank() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchConversion
 
-  
 
- rank() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchCount
 
-  
 
- rank() - Method in class com.apptus.esales.connector.report.TopSellingSearchesReport.Section
 
-  
 
- Rate - Class in com.apptus.esales.connector.report
 
- 
A wrapper class for a double representing a rate.
 
- Rate(double) - Constructor for class com.apptus.esales.connector.report.Rate
 
-  
 
- recommendation() - Method in class com.apptus.esales.connector.report.SessionSummaryReport
 
-  
 
- recommendationClicks() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- recommendationDisplays() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- remove(String) - Method in class com.apptus.esales.connector.Facets
 
- 
Return a new Facets where the given attribute is removed.
 
- report - Variable in class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- Report - Class in com.apptus.esales.connector.report
 
-  
 
- reporter(String, TimeInterval) - Method in class com.apptus.esales.connector.Connector
 
- 
Creates a reporter for a market during a specified time interval.
 
- Reporter - Class in com.apptus.esales.connector
 
- 
A Reporter fetches market-specific reports from an eSales cluster.
 
- reporterForUnknownMarket(TimeInterval) - Method in class com.apptus.esales.connector.Connector
 
- 
Creates a reporter for the unknown market (sessions without a market property), during a specified time interval.
 
- ReportException - Exception in com.apptus.esales.connector.report
 
-  
 
- ReportException(Exception) - Constructor for exception com.apptus.esales.connector.report.ReportException
 
-  
 
- ReportException(String, Exception) - Constructor for exception com.apptus.esales.connector.report.ReportException
 
-  
 
- resolution() - Method in class com.apptus.esales.connector.report.AdConversionReport
 
-  
 
- resolution() - Method in class com.apptus.esales.connector.report.SessionStatisticsReport
 
-  
 
- resolution() - Method in class com.apptus.esales.connector.report.TimelineType
 
-  
 
- result() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns the result of this panel.
 
- Result - Interface in com.apptus.esales.connector
 
- 
Base class for results parsed from the replies from an eSales service.
 
- Result.Ad - Class in com.apptus.esales.connector
 
- 
Represents a single element in a result having the ad format.
 
- Result.Ads - Class in com.apptus.esales.connector
 
- 
Represents a result having the ads format.
 
- Result.Attribute - Class in com.apptus.esales.connector
 
- 
Representation of an attribute for a product, variant, category or ad.
 
- Result.Category - Class in com.apptus.esales.connector
 
- 
 
- Result.CategoryData - Class in com.apptus.esales.connector
 
- 
A class representing a category that holds only attribute information.
 
- Result.CategoryList - Class in com.apptus.esales.connector
 
- 
Represents a result having the category_list format, which is a list of CategoryData objects.
 
- Result.CategoryNode - Class in com.apptus.esales.connector
 
- 
Represents a result having the category_tree format.
 
- Result.Completion - Class in com.apptus.esales.connector
 
- 
Represents a single element in a result having the completions format.
 
- Result.Completions - Class in com.apptus.esales.connector
 
- 
Represents a result having the completions format.
 
- Result.Correction - Class in com.apptus.esales.connector
 
- 
Represents a single element in a result having the corrections format.
 
- Result.Corrections - Class in com.apptus.esales.connector
 
- 
Represents a result having the corrections format.
 
- Result.Count - Class in com.apptus.esales.connector
 
- 
Represents a result having the count format.
 
- Result.Facet - Interface in com.apptus.esales.connector
 
-  
 
- Result.FacetList - Class in com.apptus.esales.connector
 
- 
Represents a result having the facet list format.
 
- Result.FacetRange - Class in com.apptus.esales.connector
 
- 
Represents a result having the facet_range format.
 
- Result.Phrase - Class in com.apptus.esales.connector
 
- 
Represents a single element in a result having the phrases format.
 
- Result.Phrases - Class in com.apptus.esales.connector
 
- 
Represents a result having the phrases format.
 
- Result.Product - Class in com.apptus.esales.connector
 
- 
Represents a single element in a result having the products format.
 
- Result.Products - Class in com.apptus.esales.connector
 
- 
Represents a result having the products format.
 
- Result.ResultType - Enum in com.apptus.esales.connector
 
- 
Result types
 
- Result.Value - Class in com.apptus.esales.connector
 
- 
Represents a single element in a result having the values format.
 
- Result.Values - Class in com.apptus.esales.connector
 
- 
Represents a result having the values format.
 
- Result.Variant - Class in com.apptus.esales.connector
 
- 
Represents a product variant.
 
- resultAsAds() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Ads
 
- resultAsCategoryList() - Method in class com.apptus.esales.connector.PanelContent
 
- 
 
- resultAsCategoryTree() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as a 
Result.CategoryNode object, representing the root of a (possibly partial) category tree.
 
 
- resultAsCompletions() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Completions
 
- resultAsCorrections() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Corrections
 
- resultAsCount() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Count
 
- resultAsFacetList() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as a FacetList.
 
- resultAsFacetRange() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as FacetRange
 
- resultAsPhrases() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Phrases
 
- resultAsProducts() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Products
 
- resultAsValues() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Fetches the result as Values
 
- ResultTypeException - Exception in com.apptus.esales.connector
 
- 
Thrown when trying to retrieve a result as a specific resultType, which the result does not match.
 
- retrieveContent() - Method in class com.apptus.esales.connector.DynamicPage
 
- 
Retrieves the content of this dynamic page from the eSales service.
 
- retrieveContent() - Method in class com.apptus.esales.connector.Panel
 
- 
 
- retrieveContent(Map<String, String>) - Method in class com.apptus.esales.connector.DynamicPage
 
- 
Retrieves the content of this dynamic page from the eSales service.
 
- retrieveContent(Map<String, String>) - Method in class com.apptus.esales.connector.Panel
 
- 
Retrieves the content of this panel from the eSales service.
 
- retrieveContentAsXml(Map<String, String>) - Method in class com.apptus.esales.connector.DynamicPage
 
- 
Retrieves the content of this dynamic page from the eSales service as an InputStream.
 
- retrieveContentAsXml(Map<String, String>) - Method in class com.apptus.esales.connector.Panel
 
- 
Retrieves the content of this panel from the eSales service as an InputStream.
 
- revenue() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- revenue() - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport.Section
 
-  
 
- revenue() - Method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
-  
 
- revenue() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- root() - Static method in class com.apptus.panel.Path
 
-  
 
- round(Unit, TimeZone, Locale) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Round this time point to the closest whole unit.
 
- round(Calendar) - Method in enum com.apptus.esales.connector.time.Unit
 
- 
Moves the calendar time to the closest whole unit.
 
- RUNNING - com.apptus.esales.connector.EventDataJobResult.Status
 
-  
 
- SATURDAY - com.apptus.esales.connector.time.Weekday
 
-  
 
- save(InputStream, File) - Method in class com.apptus.esales.connector.Connector
 
- 
Saves the content from an input stream to a file.
 
- search() - Method in class com.apptus.esales.connector.report.SessionSummaryReport
 
-  
 
- SearchConversion(String, int, Rate, Rate, int) - Constructor for class com.apptus.esales.connector.report.SearchStatisticsReport.SearchConversion
 
-  
 
- SearchCount(String, int, Rate, int) - Constructor for class com.apptus.esales.connector.report.SearchStatisticsReport.SearchCount
 
-  
 
- searches() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- searchesThatBoostConversion() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- searchesThatLowerConversion() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- searchesWithHits() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- searchesWithHitsTotalRate() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- searchesWithNoHits() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- searchesWithNoHitsTotalRate() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport
 
-  
 
- searchRate() - Method in class com.apptus.esales.connector.report.SearchStatisticsReport.SearchCount
 
-  
 
- searchStatistics() - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- SearchStatisticsReport - Class in com.apptus.esales.connector.report
 
- 
Report for Search statistics on the site.
 
- SearchStatisticsReport(XmlTree, TimeInterval, Rate, List<SearchStatisticsReport.SearchCount>, Rate, List<SearchStatisticsReport.SearchCount>, List<SearchStatisticsReport.SearchConversion>, List<SearchStatisticsReport.SearchConversion>, TimeZone) - Constructor for class com.apptus.esales.connector.report.SearchStatisticsReport
 
- 
Creates an SearchStatisticsReport.
 
- SearchStatisticsReport.SearchConversion - Class in com.apptus.esales.connector.report
 
- 
Class holding data for rank, count conversion rate and impact for a phrase.
 
- SearchStatisticsReport.SearchCount - Class in com.apptus.esales.connector.report
 
- 
Class holding data for rank, count and search rate for a phrase.
 
- second() - Method in class com.apptus.esales.connector.time.Time
 
-  
 
- SECOND - com.apptus.esales.connector.time.Unit
 
-  
 
- Section(int, String, int) - Constructor for class com.apptus.esales.connector.report.TopSellingSearchesReport.Section
 
-  
 
- Section(int, String, String, double, int, int, double, double) - Constructor for class com.apptus.esales.connector.report.ProductTopSellersReport.Section
 
-  
 
- Section(Ad, Rate, Rate) - Constructor for class com.apptus.esales.connector.report.AdList.Section
 
-  
 
- Section(Ad, Rate, Timeline<Rate>, Timeline<Rate>, Timeline<Rate>) - Constructor for class com.apptus.esales.connector.report.AdConversionReport.Section
 
-  
 
- Section(Ad, Timeline<Rate>, Timeline<Double>) - Constructor for class com.apptus.esales.connector.report.AdOrderValueReport.Section
 
-  
 
- Section(Ad, List<Placement>) - Constructor for class com.apptus.esales.connector.report.AdPlacementReport.Section
 
-  
 
- Section(Path, int, int, int, int, double, Rate, Rate, Rate) - Constructor for class com.apptus.esales.connector.report.PanelConversionReport.Section
 
- 
Deprecated.
 
- Section(Path, int, int, int, int, Rate, Rate, Rate, Rate) - Constructor for class com.apptus.esales.connector.report.PanelConversionReport.Section
 
- 
Deprecated.
 
- Section(String, double, int, int, double, double) - Constructor for class com.apptus.esales.connector.report.ProductSalesByAttributeReport.Section
 
-  
 
- Section(String, String, Path, int, int, int, int, double, int, Rate, Rate, Rate, Rate) - Constructor for class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- Section(String, String, Path, int, int, int, int, double, Rate, Rate, Rate) - Constructor for class com.apptus.esales.connector.report.PanelConversionReport.Section
 
- 
Deprecated.
 
- sections() - Method in class com.apptus.esales.connector.report.AdConversionReport
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.AdList
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.AdOrderValueReport
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.AdPlacementReport
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.PanelConversionReport
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.ProductSalesByAttributeReport
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.ProductTopSellersReport
 
-  
 
- sections() - Method in class com.apptus.esales.connector.report.TopSellingSearchesReport
 
-  
 
- SEPARATOR - Static variable in class com.apptus.panel.Path
 
-  
 
- SEPTEMBER - com.apptus.esales.connector.time.Month
 
-  
 
- serverLog(int, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Gets a log from a server.
 
- serverLogNames() - Method in class com.apptus.esales.connector.Connector
 
- 
Gets a list of available log names.
 
- session(String) - Method in class com.apptus.esales.connector.Connector
 
- 
Deprecated.
 
- session(String, String, String) - Method in class com.apptus.esales.connector.Connector
 
- 
Creates a session for the specified session key with the specified customer key and market.
 
- Session - Class in com.apptus.esales.connector
 
- 
A session where information is exchanged with an eSales service.
 
- sessionStatistics(Duration) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- SessionStatistics - Class in com.apptus.esales.connector.report
 
- 
 
- SessionStatistics() - Constructor for class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- SessionStatisticsReport - Class in com.apptus.esales.connector.report
 
- 
Report for Session statistics on the site.
 
- SessionStatisticsReport(XmlTree, Timeline<SessionStatistics>, TimeInterval, Duration, TimeZone) - Constructor for class com.apptus.esales.connector.report.SessionStatisticsReport
 
- 
Creates an SessionStatisticsReport.
 
- sessionSummary() - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- SessionSummaryReport - Class in com.apptus.esales.connector.report
 
- 
Report with a summary of session statistics for the entire site as well as grouped by searches and recommendations.
 
- SessionSummaryReport(XmlTree, TimeInterval, Summary, Summary, Summary, TimeZone) - Constructor for class com.apptus.esales.connector.report.SessionSummaryReport
 
- 
Creates an SessionSummaryReport.
 
- setLocale(Locale) - Method in class com.apptus.esales.connector.Reporter
 
- 
Sets the locale.
 
- setTimeZone(TimeZone) - Method in class com.apptus.esales.connector.Reporter
 
- 
Sets the time zone.
 
- sign(String) - Method in class com.apptus.esales.connector.MessageAuthentication
 
- 
Signs a message by combining it with a private key, used for prevention of unauthorized changes of the message.
 
- simpleName() - Method in class com.apptus.panel.Path
 
- 
Returns the simple name of the element denoted by this path.
 
- site() - Method in class com.apptus.esales.connector.report.SessionSummaryReport
 
-  
 
- size() - Method in class com.apptus.esales.connector.Result.Ads
 
- 
The number of ads in this result.
 
- size() - Method in class com.apptus.esales.connector.Result.Completions
 
- 
Get the number of completions found.
 
- size() - Method in class com.apptus.esales.connector.Result.Corrections
 
- 
Get the number of corrections.
 
- size() - Method in class com.apptus.esales.connector.Result.FacetList
 
- 
Get the number of facets in the list.
 
- size() - Method in class com.apptus.esales.connector.Result.Phrases
 
- 
Get the number of phrases.
 
- size() - Method in class com.apptus.esales.connector.Result.Products
 
- 
The number of products in this result.
 
- size() - Method in class com.apptus.esales.connector.Result.Values
 
- 
Get the number of values.
 
- SKUList - Class in com.apptus.esales.connector
 
- 
Deprecated.
 
- SKUList() - Constructor for class com.apptus.esales.connector.SKUList
 
- 
Deprecated.
  
- slot(Calendar) - Method in class com.apptus.esales.connector.report.TimelineType
 
-  
 
- slotEndTime() - Method in class com.apptus.esales.connector.report.TimeSlot
 
-  
 
- slotStartTime() - Method in class com.apptus.esales.connector.report.TimeSlot
 
-  
 
- start(TimeZone) - Method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Returns the start point in time, given the time zone for local
 time.
 
- startTime() - Method in class com.apptus.esales.connector.report.Ad
 
-  
 
- status() - Method in class com.apptus.esales.connector.Connector
 
- 
Returns a status report from the eSales cluster as an XML document.
 
- subpanel(String) - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns a sub panel given its relative path.
 
- Subpanel - Class in com.apptus.esales.connector
 
- 
A subpanel refers to a public panel, and can be provided to a dynamic page in order to
 retrieve content from several panels at once without having to predefine a zone.
 
- subpanels() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns a list of all sub panels in this panel.
 
- Summary - Class in com.apptus.esales.connector.report
 
- 
 
- Summary(long, long, Rate) - Constructor for class com.apptus.esales.connector.report.Summary
 
-  
 
- Summary(Rate, long, long, Rate) - Constructor for class com.apptus.esales.connector.report.Summary
 
-  
 
- SUNDAY - com.apptus.esales.connector.time.Weekday
 
-  
 
- symbol() - Method in enum com.apptus.esales.connector.time.Unit
 
-  
 
- synchronize(boolean) - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Synchronizes all eSales Servers in the eSales cluster.
 
- testPanel(String, String, String, Map<? extends CharSequence, ? extends CharSequence>) - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Deprecated.
 
- testPanel(String, String, String, Map<String, String>, String, String, String) - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Executes a panel from the specified panel definition.
 
- testPanelAndParse(String, String, String, Map<? extends CharSequence, ? extends CharSequence>) - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Deprecated.
 
- testPanelAndParse(String, String, String, Map<String, String>, String, String, String) - Method in class com.apptus.esales.connector.OnPremConnector
 
- 
Executes a panel from the specified panel definition.
 
- THURSDAY - com.apptus.esales.connector.time.Weekday
 
-  
 
- ticket() - Method in class com.apptus.esales.connector.PanelContent
 
- 
Returns the ticket of the panel
 
- time() - Method in class com.apptus.esales.connector.time.IsoDateTime
 
-  
 
- time(TimeZone) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Returns the time of day (HH:MM:SS) for this time point,
 observing local time zone.
 
- Time - Class in com.apptus.esales.connector.time
 
- 
A time of day in ISO 8601 format.
 
- Time(Integer, Integer, Integer, Integer) - Constructor for class com.apptus.esales.connector.time.Time
 
- 
Creates a time with the specified hour, minute and second.
 
- timeInterval() - Method in class com.apptus.esales.connector.report.Report
 
-  
 
- TimeInterval - Class in com.apptus.esales.connector.time
 
- 
An interval between two points in time.
 
- timeline() - Method in class com.apptus.esales.connector.report.SessionStatisticsReport
 
-  
 
- Timeline<V> - Class in com.apptus.esales.connector.report
 
- 
 
- Timeline() - Constructor for class com.apptus.esales.connector.report.Timeline
 
-  
 
- timelineType() - Method in class com.apptus.esales.connector.report.AdOrderValueReport
 
-  
 
- timelineType() - Method in class com.apptus.esales.connector.report.ProductSalesByTimeReport
 
-  
 
- TimelineType<S extends Comparable<? super S>> - Class in com.apptus.esales.connector.report
 
- 
Enumeration for report timeline types
 
- TimeoutSettings - Class in com.apptus.esales.connector
 
-  
 
- TimeoutSettings(int, int, int, int, int, int, int) - Constructor for class com.apptus.esales.connector.TimeoutSettings
 
-  
 
- TimePoint - Class in com.apptus.esales.connector.time
 
- 
A point on the time scale.
 
- TimeSlot<V> - Class in com.apptus.esales.connector.report
 
- 
A class representing time slots in the reports.
 
- TimeSlot(long, long, String, V) - Constructor for class com.apptus.esales.connector.report.TimeSlot
 
-  
 
- TimeSlot(TimePoint, TimePoint, String, V) - Constructor for class com.apptus.esales.connector.report.TimeSlot
 
-  
 
- toCalendar(TimeZone) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Converts this time point to a Gregorian calendar with the specified
 time zone and the default locale.
 
- toCalendar(TimeZone, Locale) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Converts this time point to a Gregorian calendar with the specified
 time zone and locale.
 
- toCalendarDayOfWeek() - Method in enum com.apptus.esales.connector.time.Weekday
 
-  
 
- toCalendarMonth() - Method in enum com.apptus.esales.connector.time.Month
 
- 
Translate to Java Calender constant.
 
- toDate() - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Converts this time point to a java.util.Date object.
 
- today(TimeZone) - Static method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Convenience method for returning a time interval covering today.
 
- today(TimeZone) - Static method in class com.apptus.esales.connector.time.TimePoint
 
-  
 
- toDays() - Method in class com.apptus.esales.connector.time.Duration
 
- 
Calculated as if it was an interval from 1 Jan 1970 00:00 UTC and forward.
 
- toggle(String, String) - Method in class com.apptus.esales.connector.Facets
 
- 
Toggle the given attribute and value.
 
- toList() - Method in class com.apptus.esales.connector.ProductStreamer
 
- 
Iterates through all products and returns them as a list.
 
- toMillis() - Method in class com.apptus.esales.connector.time.Duration
 
- 
Calculated as if it was an interval from 1 Jan 1970 00:00 UTC and forward.
 
- toMillis() - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Converts this time point to Epoch time, i.e.
 
- toMillis(TimeZone) - Method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Returns the length in milliseconds for this time interval,
 given a local time zone.
 
- topSellingSearches(Filter, int, int) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- topSellingSearches(Filter, Facets, int, int) - Method in class com.apptus.esales.connector.Reporter
 
- 
 
- TopSellingSearchesReport - Class in com.apptus.esales.connector.report
 
- 
Report for search phrases associated with the products and variants that matches a filter.
 
- TopSellingSearchesReport.Section - Class in com.apptus.esales.connector.report
 
- 
Sub class for 
TopSellingSearchesReport Contains a search phrase together with
 the total number of times the search phrase has lead to a purchase of a product or a variant that matches the filter specified in the report.
 
 
- toString() - Method in class com.apptus.esales.connector.Facets
 
- 
Builds and returns a string on the facet argument format.
 
- toString() - Method in class com.apptus.esales.connector.Filter
 
-  
 
- toString() - Method in class com.apptus.esales.connector.PanelContent
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.Ad.Attribute
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.Ad
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.PanelConversionReport.Section
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.Placement
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.Rate
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.SessionStatistics
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.TimelineType
 
-  
 
- toString() - Method in class com.apptus.esales.connector.report.TimeSlot
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Ad
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Ads
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Attribute
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Category
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Completion
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Completions
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Correction
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Corrections
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Count
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.FacetList
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Phrase
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Phrases
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Product
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Products
 
-  
 
- toString() - Method in interface com.apptus.esales.connector.Result
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Value
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Values
 
-  
 
- toString() - Method in class com.apptus.esales.connector.Result.Variant
 
-  
 
- toString() - Method in class com.apptus.esales.connector.time.CalendarDate
 
-  
 
- toString() - Method in class com.apptus.esales.connector.time.Duration
 
-  
 
- toString() - Method in class com.apptus.esales.connector.time.IsoDate
 
- 
Returns this date in ISO 8601 format.
 
- toString() - Method in class com.apptus.esales.connector.time.IsoDateTime
 
- 
Returns this date and time in ISO 8601 format: <date>T<time>.
 
- toString() - Method in class com.apptus.esales.connector.time.OrdinalDate
 
-  
 
- toString() - Method in class com.apptus.esales.connector.time.Time
 
-  
 
- toString() - Method in class com.apptus.esales.connector.time.TimeInterval
 
- 
Returns an ISO 8601 formatted string representing this time interval.
 
- toString() - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
Returns a string on the format YYYY-MM-DDTHH:MM:SSZ representing this
 time point.
 
- toString() - Method in class com.apptus.esales.connector.time.WeekDate
 
-  
 
- toString() - Method in class com.apptus.panel.Path
 
-  
 
- toString(boolean) - Method in class com.apptus.esales.connector.time.TimePoint
 
- 
If formal, returns a string on the format YYYY-MM-DDTHH:MM:SSZ representing this
 time point.
 
- toTimePoint(Time, TimeZone) - Method in class com.apptus.esales.connector.time.CalendarDate
 
-  
 
- toTimePoint(Time, TimeZone) - Method in class com.apptus.esales.connector.time.IsoDate
 
- 
Returns a point in time represented by this date and a supplied
 time of day.
 
- toTimePoint(Time, TimeZone) - Method in class com.apptus.esales.connector.time.OrdinalDate
 
-  
 
- toTimePoint(Time, TimeZone) - Method in class com.apptus.esales.connector.time.WeekDate
 
-  
 
- toTimePoint(TimeZone) - Method in class com.apptus.esales.connector.time.IsoDateTime
 
- 
Returns a point in time represented by this date-time object.
 
- TUESDAY - com.apptus.esales.connector.time.Weekday
 
-