001 /** 002 * Copyright (c) 2000-2013 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 com.liferay.portal.kernel.exception.PortalException; 018 import com.liferay.portal.kernel.exception.SystemException; 019 import com.liferay.portal.kernel.transaction.Isolation; 020 import com.liferay.portal.kernel.transaction.Propagation; 021 import com.liferay.portal.kernel.transaction.Transactional; 022 import com.liferay.portal.service.BaseLocalService; 023 import com.liferay.portal.service.PersistedModelLocalService; 024 025 /** 026 * Provides the local service interface for ShoppingCoupon. Methods of this 027 * service will not have security checks based on the propagated JAAS 028 * credentials because this service can only be accessed from within the same 029 * VM. 030 * 031 * @author Brian Wing Shun Chan 032 * @see ShoppingCouponLocalServiceUtil 033 * @see com.liferay.portlet.shopping.service.base.ShoppingCouponLocalServiceBaseImpl 034 * @see com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl 035 * @generated 036 */ 037 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 038 PortalException.class, SystemException.class}) 039 public interface ShoppingCouponLocalService extends BaseLocalService, 040 PersistedModelLocalService { 041 /* 042 * NOTE FOR DEVELOPERS: 043 * 044 * Never modify or reference this interface directly. Always use {@link ShoppingCouponLocalServiceUtil} to access the shopping coupon local service. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingCouponLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 045 */ 046 047 /** 048 * Adds the shopping coupon to the database. Also notifies the appropriate model listeners. 049 * 050 * @param shoppingCoupon the shopping coupon 051 * @return the shopping coupon that was added 052 * @throws SystemException if a system exception occurred 053 */ 054 public com.liferay.portlet.shopping.model.ShoppingCoupon addShoppingCoupon( 055 com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon) 056 throws com.liferay.portal.kernel.exception.SystemException; 057 058 /** 059 * Creates a new shopping coupon with the primary key. Does not add the shopping coupon to the database. 060 * 061 * @param couponId the primary key for the new shopping coupon 062 * @return the new shopping coupon 063 */ 064 public com.liferay.portlet.shopping.model.ShoppingCoupon createShoppingCoupon( 065 long couponId); 066 067 /** 068 * Deletes the shopping coupon with the primary key from the database. Also notifies the appropriate model listeners. 069 * 070 * @param couponId the primary key of the shopping coupon 071 * @return the shopping coupon that was removed 072 * @throws PortalException if a shopping coupon with the primary key could not be found 073 * @throws SystemException if a system exception occurred 074 */ 075 public com.liferay.portlet.shopping.model.ShoppingCoupon deleteShoppingCoupon( 076 long couponId) 077 throws com.liferay.portal.kernel.exception.PortalException, 078 com.liferay.portal.kernel.exception.SystemException; 079 080 /** 081 * Deletes the shopping coupon from the database. Also notifies the appropriate model listeners. 082 * 083 * @param shoppingCoupon the shopping coupon 084 * @return the shopping coupon that was removed 085 * @throws SystemException if a system exception occurred 086 */ 087 public com.liferay.portlet.shopping.model.ShoppingCoupon deleteShoppingCoupon( 088 com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon) 089 throws com.liferay.portal.kernel.exception.SystemException; 090 091 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 092 093 /** 094 * Performs a dynamic query on the database and returns the matching rows. 095 * 096 * @param dynamicQuery the dynamic query 097 * @return the matching rows 098 * @throws SystemException if a system exception occurred 099 */ 100 @SuppressWarnings("rawtypes") 101 public java.util.List dynamicQuery( 102 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 103 throws com.liferay.portal.kernel.exception.SystemException; 104 105 /** 106 * Performs a dynamic query on the database and returns a range of the matching rows. 107 * 108 * <p> 109 * 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.ShoppingCouponModelImpl}. 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. 110 * </p> 111 * 112 * @param dynamicQuery the dynamic query 113 * @param start the lower bound of the range of model instances 114 * @param end the upper bound of the range of model instances (not inclusive) 115 * @return the range of matching rows 116 * @throws SystemException if a system exception occurred 117 */ 118 @SuppressWarnings("rawtypes") 119 public java.util.List dynamicQuery( 120 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 121 int end) throws com.liferay.portal.kernel.exception.SystemException; 122 123 /** 124 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 125 * 126 * <p> 127 * 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.ShoppingCouponModelImpl}. 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 134 * @return the ordered range of matching rows 135 * @throws SystemException if a system exception occurred 136 */ 137 @SuppressWarnings("rawtypes") 138 public java.util.List dynamicQuery( 139 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 140 int end, 141 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Returns the number of rows that match the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows that match the dynamic query 149 * @throws SystemException if a system exception occurred 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Returns the number of rows that match the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @param projection the projection to apply to the query 160 * @return the number of rows that match the dynamic query 161 * @throws SystemException if a system exception occurred 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 165 com.liferay.portal.kernel.dao.orm.Projection projection) 166 throws com.liferay.portal.kernel.exception.SystemException; 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portlet.shopping.model.ShoppingCoupon fetchShoppingCoupon( 170 long couponId) 171 throws com.liferay.portal.kernel.exception.SystemException; 172 173 /** 174 * Returns the shopping coupon with the primary key. 175 * 176 * @param couponId the primary key of the shopping coupon 177 * @return the shopping coupon 178 * @throws PortalException if a shopping coupon with the primary key could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portlet.shopping.model.ShoppingCoupon getShoppingCoupon( 183 long couponId) 184 throws com.liferay.portal.kernel.exception.PortalException, 185 com.liferay.portal.kernel.exception.SystemException; 186 187 @Override 188 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 189 public com.liferay.portal.model.PersistedModel getPersistedModel( 190 java.io.Serializable primaryKeyObj) 191 throws com.liferay.portal.kernel.exception.PortalException, 192 com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Returns a range of all the shopping coupons. 196 * 197 * <p> 198 * 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.ShoppingCouponModelImpl}. 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. 199 * </p> 200 * 201 * @param start the lower bound of the range of shopping coupons 202 * @param end the upper bound of the range of shopping coupons (not inclusive) 203 * @return the range of shopping coupons 204 * @throws SystemException if a system exception occurred 205 */ 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> getShoppingCoupons( 208 int start, int end) 209 throws com.liferay.portal.kernel.exception.SystemException; 210 211 /** 212 * Returns the number of shopping coupons. 213 * 214 * @return the number of shopping coupons 215 * @throws SystemException if a system exception occurred 216 */ 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public int getShoppingCouponsCount() 219 throws com.liferay.portal.kernel.exception.SystemException; 220 221 /** 222 * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 223 * 224 * @param shoppingCoupon the shopping coupon 225 * @return the shopping coupon that was updated 226 * @throws SystemException if a system exception occurred 227 */ 228 public com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon( 229 com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon) 230 throws com.liferay.portal.kernel.exception.SystemException; 231 232 /** 233 * Returns the Spring bean ID for this bean. 234 * 235 * @return the Spring bean ID for this bean 236 */ 237 public java.lang.String getBeanIdentifier(); 238 239 /** 240 * Sets the Spring bean ID for this bean. 241 * 242 * @param beanIdentifier the Spring bean ID for this bean 243 */ 244 public void setBeanIdentifier(java.lang.String beanIdentifier); 245 246 public com.liferay.portlet.shopping.model.ShoppingCoupon addCoupon( 247 long userId, java.lang.String code, boolean autoCode, 248 java.lang.String name, java.lang.String description, 249 int startDateMonth, int startDateDay, int startDateYear, 250 int startDateHour, int startDateMinute, int endDateMonth, 251 int endDateDay, int endDateYear, int endDateHour, int endDateMinute, 252 boolean neverExpire, boolean active, java.lang.String limitCategories, 253 java.lang.String limitSkus, double minOrder, double discount, 254 java.lang.String discountType, 255 com.liferay.portal.service.ServiceContext serviceContext) 256 throws com.liferay.portal.kernel.exception.PortalException, 257 com.liferay.portal.kernel.exception.SystemException; 258 259 public void deleteCoupon(long couponId) 260 throws com.liferay.portal.kernel.exception.PortalException, 261 com.liferay.portal.kernel.exception.SystemException; 262 263 public void deleteCoupon( 264 com.liferay.portlet.shopping.model.ShoppingCoupon coupon) 265 throws com.liferay.portal.kernel.exception.SystemException; 266 267 public void deleteCoupons(long groupId) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 271 public com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon( 272 long couponId) 273 throws com.liferay.portal.kernel.exception.PortalException, 274 com.liferay.portal.kernel.exception.SystemException; 275 276 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 277 public com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon( 278 java.lang.String code) 279 throws com.liferay.portal.kernel.exception.PortalException, 280 com.liferay.portal.kernel.exception.SystemException; 281 282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 283 public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> search( 284 long groupId, long companyId, java.lang.String code, boolean active, 285 java.lang.String discountType, boolean andOperator, int start, int end) 286 throws com.liferay.portal.kernel.exception.SystemException; 287 288 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 289 public int searchCount(long groupId, long companyId, java.lang.String code, 290 boolean active, java.lang.String discountType, boolean andOperator) 291 throws com.liferay.portal.kernel.exception.SystemException; 292 293 public com.liferay.portlet.shopping.model.ShoppingCoupon updateCoupon( 294 long userId, long couponId, java.lang.String name, 295 java.lang.String description, int startDateMonth, int startDateDay, 296 int startDateYear, int startDateHour, int startDateMinute, 297 int endDateMonth, int endDateDay, int endDateYear, int endDateHour, 298 int endDateMinute, boolean neverExpire, boolean active, 299 java.lang.String limitCategories, java.lang.String limitSkus, 300 double minOrder, double discount, java.lang.String discountType, 301 com.liferay.portal.service.ServiceContext serviceContext) 302 throws com.liferay.portal.kernel.exception.PortalException, 303 com.liferay.portal.kernel.exception.SystemException; 304 }