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