Package org.broadleafcommerce.core.web.linkeddata.generator

Interface LinkedDataGeneratorExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractLinkedDataGeneratorExtensionHandler, DefaultLinkedDataGeneratorExtensionHandler

public interface LinkedDataGeneratorExtensionHandler
extends ExtensionHandler

Extension handler for extending functionality of LinkedDataGenerator. Implementors should extend from AbstractLinkedDataGeneratorExtensionHandler to protect from API changes to this interface

Author:

Nathan Moore (nathanmoore).

Method Summary

Modifier and Type	Method	Description
ExtensionResultStatusType	addAggregateReviewData(jakarta.servlet.http.HttpServletRequest request, Product product, org.codehaus.jettison.json.JSONObject reviewData)
ExtensionResultStatusType	addAggregateSkuData(jakarta.servlet.http.HttpServletRequest request, Product product, org.codehaus.jettison.json.JSONObject skuData)
ExtensionResultStatusType	addBreadcrumbData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject breadcrumbData)
ExtensionResultStatusType	addBreadcrumbItemData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject breadcrumbData)
ExtensionResultStatusType	addBreadcrumbListItemData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject breadcrumbData)
ExtensionResultStatusType	addCategoryData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject categoryData)
ExtensionResultStatusType	addCategoryProductData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject categoryData)
ExtensionResultStatusType	addContactData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)
ExtensionResultStatusType	addDefaultData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONArray schemaObjects)
ExtensionResultStatusType	addHomepageData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONArray schemaObjects)
ExtensionResultStatusType	addOrganizationData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)
ExtensionResultStatusType	addPotentialActionsData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)
ExtensionResultStatusType	addProductData(jakarta.servlet.http.HttpServletRequest request, Product product, org.codehaus.jettison.json.JSONObject productData)
ExtensionResultStatusType	addReviewData(jakarta.servlet.http.HttpServletRequest request, Product product, org.codehaus.jettison.json.JSONObject reviewData)
ExtensionResultStatusType	addSkuData(jakarta.servlet.http.HttpServletRequest request, Product product, org.codehaus.jettison.json.JSONObject skuData)
ExtensionResultStatusType	addSocialMediaData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONArray homepageData)
ExtensionResultStatusType	addWebSiteData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Details

addDefaultData

ExtensionResultStatusType addDefaultData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONArray schemaObjects)
                                  throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addBreadcrumbData

ExtensionResultStatusType addBreadcrumbData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject breadcrumbData)
                                     throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addBreadcrumbListItemData

ExtensionResultStatusType addBreadcrumbListItemData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject breadcrumbData)
                                             throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addBreadcrumbItemData

ExtensionResultStatusType addBreadcrumbItemData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject breadcrumbData)
                                         throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addHomepageData

ExtensionResultStatusType addHomepageData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONArray schemaObjects)
                                   throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addWebSiteData

ExtensionResultStatusType addWebSiteData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject homepageData)
                                  throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addOrganizationData

ExtensionResultStatusType addOrganizationData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject homepageData)
                                       throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addContactData

ExtensionResultStatusType addContactData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject homepageData)
                                  throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addSocialMediaData

ExtensionResultStatusType addSocialMediaData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONArray homepageData)
                                      throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addPotentialActionsData

ExtensionResultStatusType addPotentialActionsData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject homepageData)
                                           throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addCategoryData

ExtensionResultStatusType addCategoryData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject categoryData)
                                   throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addCategoryProductData

ExtensionResultStatusType addCategoryProductData(jakarta.servlet.http.HttpServletRequest request,
 org.codehaus.jettison.json.JSONObject categoryData)
                                          throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addReviewData

ExtensionResultStatusType addReviewData(jakarta.servlet.http.HttpServletRequest request,
 Product product,
 org.codehaus.jettison.json.JSONObject reviewData)
                                 throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addAggregateReviewData

ExtensionResultStatusType addAggregateReviewData(jakarta.servlet.http.HttpServletRequest request,
 Product product,
 org.codehaus.jettison.json.JSONObject reviewData)
                                          throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addProductData

ExtensionResultStatusType addProductData(jakarta.servlet.http.HttpServletRequest request,
 Product product,
 org.codehaus.jettison.json.JSONObject productData)
                                  throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addSkuData

ExtensionResultStatusType addSkuData(jakarta.servlet.http.HttpServletRequest request,
 Product product,
 org.codehaus.jettison.json.JSONObject skuData)
                              throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addAggregateSkuData

ExtensionResultStatusType addAggregateSkuData(jakarta.servlet.http.HttpServletRequest request,
 Product product,
 org.codehaus.jettison.json.JSONObject skuData)
                                       throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException