de.hybris.platform.oci.jalo.interfaces

Interface CatalogLoginPerformer

All Known Implementing Classes:

DefaultCatalogLoginPerformer

public interface CatalogLoginPerformer

Interface for communication between SRM Server and the catalog.
The implementation of this interface contains the logic for login into the catalog and the logic for the SRM special functions.

Method Summary

Modifier and Type	Method and Description
SAPProductList	backgroundSearch(String searchstring) This method searches the catalog using the given searchstring and returns the search result as SAPProductList. A HTML document which contains the results in OCI Format (a html form with inserted xml data) will be sent to the SRM server back. It is the implementation of SRM Server request: FUNCTION=BACKGROUND_SEARCH - the results will be showed in the SRM Server.
String	getHookURLFieldName() In SAP SRM Server the fieldname for the HOOK_URL can vary and must be specified for the oci extension.
String	getProductDetailURL(String productID) This method returns an URL of the shop where the product with the given unique productID is shown.
SAPProduct	getProductInfoForValidation(String productID, double quantity) This method validates the given product and quantity in the SRM Server.
String	getProductSearchURL(String searchstring, String vendor) For the given searchstring and vendor, this method returns the catalog specific URL from the catalog search function.
String	getShopURL() This method returns the entry URL (as String) of the shop (default start/home page of the shop).
void	login(HttpServletRequest request, HttpServletResponse response, OutboundSection outboundsection) This method logs in into the shop from the SRM Server. This is catalog specific and has to be implemented in this method.

Method Detail

login

void login(HttpServletRequest request,
           HttpServletResponse response,
           OutboundSection outboundsection)
    throws OciException

This method logs in into the shop from the SRM Server.
This is catalog specific and has to be implemented in this method.

Parameters:

request - contains the needed parameter from SRM Server

response - catalog data will be sent there

outboundsection - implementation of the Interface OutboundSection

Throws:

OciException - throws an OciException if an OCI-related error occurs

backgroundSearch

SAPProductList backgroundSearch(String searchstring)

This method searches the catalog using the given searchstring and returns the search result as SAPProductList.
A HTML document which contains the results in OCI Format (a html form with inserted xml data) will be sent to the SRM server back.
It is the implementation of SRM Server request: FUNCTION=BACKGROUND_SEARCH - the results will be showed in the SRM Server.

Parameters:

searchstring - the search String

Returns:

the implemented Interface of SAPProductList which contains the search result

getProductSearchURL

String getProductSearchURL(String searchstring,
                           String vendor)

For the given searchstring and vendor, this method returns the catalog specific URL from the catalog search function.
This is the implementation of SRM Server request: FUNCTION=SOURCING - the results will be shown in the catalog specific result page.

Parameters:

searchstring - the search string

vendor - vendor

Returns:

an URL to the catalog search page

getProductInfoForValidation

SAPProduct getProductInfoForValidation(String productID,
                                       double quantity)

This method validates the given product and quantity in the SRM Server. As response, the method returns the product which is identified by the ID String. The data of the product will be sent back to the SRM Server.
This is the implementation of SRM Server request: FUNCTION=VALIDATE - the results will be showed in the SRM Server.

Parameters:

productID - the (unique) ProductID of the product in the shop

quantity - quantity of the product

getShopURL

String getShopURL()

This method returns the entry URL (as String) of the shop (default start/home page of the shop).

Returns:

link (as String) to the start page of the shop

getProductDetailURL

String getProductDetailURL(String productID)

This method returns an URL of the shop where the product with the given unique productID is shown. For example, this could be the shop specific page for product details. This is the implementation of SRM Server request: FUNCTION=DETAIL.

Parameters:

productID - this is the productID from the shop

Returns:

link (as String) to the specific product detail page

getHookURLFieldName

String getHookURLFieldName()

In SAP SRM Server the fieldname for the HOOK_URL can vary and must be specified for the oci extension. For default this method should return (default implementation in SRM Server): "HOOK_URL".

Returns:

the field name where the HOOK_URL is stored