001 /** 002 * Copyright (c) 2000-present Liferay, Inc. All rights reserved. 003 * 004 * This library is free software; you can redistribute it and/or modify it under 005 * the terms of the GNU Lesser General Public License as published by the Free 006 * Software Foundation; either version 2.1 of the License, or (at your option) 007 * any later version. 008 * 009 * This library is distributed in the hope that it will be useful, but WITHOUT 010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 011 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more 012 * details. 013 */ 014 015 package com.liferay.portlet.shopping.service; 016 017 import aQute.bnd.annotation.ProviderType; 018 019 import com.liferay.portal.kernel.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for ShoppingCart. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see ShoppingCartLocalServiceUtil 036 * @see com.liferay.portlet.shopping.service.base.ShoppingCartLocalServiceBaseImpl 037 * @see com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface ShoppingCartLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link ShoppingCartLocalServiceUtil} to access the shopping cart local service. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingCartLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the shopping cart to the database. Also notifies the appropriate model listeners. 053 * 054 * @param shoppingCart the shopping cart 055 * @return the shopping cart that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.shopping.model.ShoppingCart addShoppingCart( 059 com.liferay.portlet.shopping.model.ShoppingCart shoppingCart); 060 061 /** 062 * Creates a new shopping cart with the primary key. Does not add the shopping cart to the database. 063 * 064 * @param cartId the primary key for the new shopping cart 065 * @return the new shopping cart 066 */ 067 public com.liferay.portlet.shopping.model.ShoppingCart createShoppingCart( 068 long cartId); 069 070 public void deleteGroupCarts(long groupId); 071 072 /** 073 * @throws PortalException 074 */ 075 @Override 076 public com.liferay.portal.model.PersistedModel deletePersistedModel( 077 com.liferay.portal.model.PersistedModel persistedModel) 078 throws PortalException; 079 080 /** 081 * Deletes the shopping cart with the primary key from the database. Also notifies the appropriate model listeners. 082 * 083 * @param cartId the primary key of the shopping cart 084 * @return the shopping cart that was removed 085 * @throws PortalException if a shopping cart with the primary key could not be found 086 */ 087 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 088 public com.liferay.portlet.shopping.model.ShoppingCart deleteShoppingCart( 089 long cartId) throws PortalException; 090 091 /** 092 * Deletes the shopping cart from the database. Also notifies the appropriate model listeners. 093 * 094 * @param shoppingCart the shopping cart 095 * @return the shopping cart that was removed 096 */ 097 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 098 public com.liferay.portlet.shopping.model.ShoppingCart deleteShoppingCart( 099 com.liferay.portlet.shopping.model.ShoppingCart shoppingCart); 100 101 public void deleteUserCarts(long userId); 102 103 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 104 105 /** 106 * Performs a dynamic query on the database and returns the matching rows. 107 * 108 * @param dynamicQuery the dynamic query 109 * @return the matching rows 110 */ 111 public <T> java.util.List<T> dynamicQuery( 112 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 116 * 117 * <p> 118 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCartModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 */ 126 public <T> java.util.List<T> dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end); 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCartModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 */ 143 public <T> java.util.List<T> dynamicQuery( 144 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 145 int end, 146 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 147 148 /** 149 * Returns the number of rows matching the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows matching the dynamic query 153 */ 154 public long dynamicQueryCount( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 156 157 /** 158 * Returns the number of rows matching the dynamic query. 159 * 160 * @param dynamicQuery the dynamic query 161 * @param projection the projection to apply to the query 162 * @return the number of rows matching the dynamic query 163 */ 164 public long dynamicQueryCount( 165 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 166 com.liferay.portal.kernel.dao.orm.Projection projection); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portlet.shopping.model.ShoppingCart fetchShoppingCart( 170 long cartId); 171 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 174 175 /** 176 * Returns the Spring bean ID for this bean. 177 * 178 * @return the Spring bean ID for this bean 179 */ 180 public java.lang.String getBeanIdentifier(); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portlet.shopping.model.ShoppingCart getCart( 184 long userId, long groupId) throws PortalException; 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public java.util.Map<com.liferay.portlet.shopping.model.ShoppingCartItem, java.lang.Integer> getItems( 188 long groupId, java.lang.String itemIds); 189 190 @Override 191 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 192 public com.liferay.portal.model.PersistedModel getPersistedModel( 193 java.io.Serializable primaryKeyObj) throws PortalException; 194 195 /** 196 * Returns the shopping cart with the primary key. 197 * 198 * @param cartId the primary key of the shopping cart 199 * @return the shopping cart 200 * @throws PortalException if a shopping cart with the primary key could not be found 201 */ 202 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 203 public com.liferay.portlet.shopping.model.ShoppingCart getShoppingCart( 204 long cartId) throws PortalException; 205 206 /** 207 * Returns a range of all the shopping carts. 208 * 209 * <p> 210 * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.shopping.model.impl.ShoppingCartModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order. 211 * </p> 212 * 213 * @param start the lower bound of the range of shopping carts 214 * @param end the upper bound of the range of shopping carts (not inclusive) 215 * @return the range of shopping carts 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public java.util.List<com.liferay.portlet.shopping.model.ShoppingCart> getShoppingCarts( 219 int start, int end); 220 221 /** 222 * Returns the number of shopping carts. 223 * 224 * @return the number of shopping carts 225 */ 226 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 227 public int getShoppingCartsCount(); 228 229 /** 230 * Sets the Spring bean ID for this bean. 231 * 232 * @param beanIdentifier the Spring bean ID for this bean 233 */ 234 public void setBeanIdentifier(java.lang.String beanIdentifier); 235 236 public com.liferay.portlet.shopping.model.ShoppingCart updateCart( 237 long userId, long groupId, java.lang.String itemIds, 238 java.lang.String couponCodes, int altShipping, boolean insure) 239 throws PortalException; 240 241 /** 242 * Updates the shopping cart in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 243 * 244 * @param shoppingCart the shopping cart 245 * @return the shopping cart that was updated 246 */ 247 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 248 public com.liferay.portlet.shopping.model.ShoppingCart updateShoppingCart( 249 com.liferay.portlet.shopping.model.ShoppingCart shoppingCart); 250 }