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

Interface LinkedDataGeneratorExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

All Known Implementing Classes:

AbstractLinkedDataGeneratorExtensionHandler, DefaultLinkedDataGeneratorExtensionHandler

public interface LinkedDataGeneratorExtensionHandler
extends org.broadleafcommerce.common.extension.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
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addAggregateReviewData(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.catalog.domain.Product product, org.codehaus.jettison.json.JSONObject reviewData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addAggregateSkuData(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.catalog.domain.Product product, org.codehaus.jettison.json.JSONObject skuData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addBreadcrumbData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject breadcrumbData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addBreadcrumbItemData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject breadcrumbData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addBreadcrumbListItemData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject breadcrumbData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addCategoryData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject categoryData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addCategoryProductData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject categoryData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addContactData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addDefaultData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONArray schemaObjects)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addHomepageData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONArray schemaObjects)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addOrganizationData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addPotentialActionsData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONObject homepageData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addProductData(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.catalog.domain.Product product, org.codehaus.jettison.json.JSONObject productData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addReviewData(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.catalog.domain.Product product, org.codehaus.jettison.json.JSONObject reviewData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addSkuData(jakarta.servlet.http.HttpServletRequest request, org.broadleafcommerce.core.catalog.domain.Product product, org.codehaus.jettison.json.JSONObject skuData)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addSocialMediaData(jakarta.servlet.http.HttpServletRequest request, org.codehaus.jettison.json.JSONArray homepageData)
org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.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

org.broadleafcommerce.common.extension.ExtensionResultStatusType addReviewData(jakarta.servlet.http.HttpServletRequest request,
 org.broadleafcommerce.core.catalog.domain.Product product,
 org.codehaus.jettison.json.JSONObject reviewData)
                                                                        throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addAggregateReviewData

org.broadleafcommerce.common.extension.ExtensionResultStatusType addAggregateReviewData(jakarta.servlet.http.HttpServletRequest request,
 org.broadleafcommerce.core.catalog.domain.Product product,
 org.codehaus.jettison.json.JSONObject reviewData)
                                                                                 throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addProductData

org.broadleafcommerce.common.extension.ExtensionResultStatusType addProductData(jakarta.servlet.http.HttpServletRequest request,
 org.broadleafcommerce.core.catalog.domain.Product product,
 org.codehaus.jettison.json.JSONObject productData)
                                                                         throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addSkuData

org.broadleafcommerce.common.extension.ExtensionResultStatusType addSkuData(jakarta.servlet.http.HttpServletRequest request,
 org.broadleafcommerce.core.catalog.domain.Product product,
 org.codehaus.jettison.json.JSONObject skuData)
                                                                     throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException

addAggregateSkuData

org.broadleafcommerce.common.extension.ExtensionResultStatusType addAggregateSkuData(jakarta.servlet.http.HttpServletRequest request,
 org.broadleafcommerce.core.catalog.domain.Product product,
 org.codehaus.jettison.json.JSONObject skuData)
                                                                              throws org.codehaus.jettison.json.JSONException

Throws:

org.codehaus.jettison.json.JSONException