com.adobe.cq.commerce.api.conf.CommerceBasePathsService Maven / Gradle / Ivy
/*************************************************************************
*
* ADOBE CONFIDENTIAL
* __________________
*
* Copyright 2017 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any. The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
**************************************************************************/
package com.adobe.cq.commerce.api.conf;
import aQute.bnd.annotation.ProviderType;
/**
* OSGI Service used to retrieve commerce JCR content base paths.
*/
@ProviderType
public interface CommerceBasePathsService {
/**
* Returns the JCR base path for the commerce classifications.
* Example: /var/commerce/classifications.
*
* @return String representing the JCR path for the commerce classifications path, never null.
*/
String getClassificationsBasePath();
/**
* Returns the JCR base path for the commerce collections.
* Example: /var/commerce/collections.
*
* @return String representing the JCR path for the commerce collections path, never null.
*/
String getCollectionsBasePath();
/**
* Returns the JCR base path for the commerce orders.
* Example: /var/commerce/orders.
*
* @return String representing the JCR path for the commerce orders path, never null.
*/
String getOrdersBasePath();
/**
* Returns the JCR base path for the commerce payment methods.
* Example: /var/commerce/payment-methods.
*
* @return String representing the JCR path for the commerce payment methods path, never null.
*/
String getPaymentMethodsBasePath();
/**
* Returns the JCR base path for the commerce products.
* Example: /var/commerce/products.
*
* @return String representing the JCR path for the commerce products path, never null.
*/
String getProductsBasePath();
/**
* Returns the JCR base path for the commerce shipping methods.
* Example: /var/commerce/shipping-methods.
*
* @return String representing the JCR path for the commerce shipping methods path, never null.
*/
String getShippingMethodsBasePath();
/**
* Returns the JCR base path for the commerce scaffolding.
* Example: /apps.
*
* @return String representing the JCR path for the commerce scaffolding, never null.
*/
String getScaffoldingBasePath();
}