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