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 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) throws PortalException; 085 086 public void deleteCoupons(long groupId); 087 088 /** 089 * @throws PortalException 090 */ 091 @Override 092 public com.liferay.portal.model.PersistedModel deletePersistedModel( 093 com.liferay.portal.model.PersistedModel persistedModel) 094 throws PortalException; 095 096 /** 097 * Deletes the shopping coupon with the primary key from the database. Also notifies the appropriate model listeners. 098 * 099 * @param couponId the primary key of the shopping coupon 100 * @return the shopping coupon that was removed 101 * @throws PortalException if a shopping coupon with the primary key could not be found 102 */ 103 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 104 public com.liferay.portlet.shopping.model.ShoppingCoupon deleteShoppingCoupon( 105 long couponId) throws PortalException; 106 107 /** 108 * Deletes the shopping coupon from the database. Also notifies the appropriate model listeners. 109 * 110 * @param shoppingCoupon the shopping coupon 111 * @return the shopping coupon that was removed 112 */ 113 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 114 public com.liferay.portlet.shopping.model.ShoppingCoupon deleteShoppingCoupon( 115 com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon); 116 117 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 118 119 /** 120 * Performs a dynamic query on the database and returns the matching rows. 121 * 122 * @param dynamicQuery the dynamic query 123 * @return the matching rows 124 */ 125 public <T> java.util.List<T> dynamicQuery( 126 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 127 128 /** 129 * Performs a dynamic query on the database and returns a range of the matching rows. 130 * 131 * <p> 132 * 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. 133 * </p> 134 * 135 * @param dynamicQuery the dynamic query 136 * @param start the lower bound of the range of model instances 137 * @param end the upper bound of the range of model instances (not inclusive) 138 * @return the range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end); 143 144 /** 145 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 146 * 147 * <p> 148 * 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. 149 * </p> 150 * 151 * @param dynamicQuery the dynamic query 152 * @param start the lower bound of the range of model instances 153 * @param end the upper bound of the range of model instances (not inclusive) 154 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 155 * @return the ordered range of matching rows 156 */ 157 public <T> java.util.List<T> dynamicQuery( 158 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 159 int end, 160 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 161 162 /** 163 * Returns the number of rows matching the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @return the number of rows matching the dynamic query 167 */ 168 public long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 170 171 /** 172 * Returns the number of rows matching the dynamic query. 173 * 174 * @param dynamicQuery the dynamic query 175 * @param projection the projection to apply to the query 176 * @return the number of rows matching the dynamic query 177 */ 178 public long dynamicQueryCount( 179 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 180 com.liferay.portal.kernel.dao.orm.Projection projection); 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portlet.shopping.model.ShoppingCoupon fetchShoppingCoupon( 184 long couponId); 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 188 189 /** 190 * Returns the Spring bean ID for this bean. 191 * 192 * @return the Spring bean ID for this bean 193 */ 194 public java.lang.String getBeanIdentifier(); 195 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon( 198 java.lang.String code) throws PortalException; 199 200 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 201 public com.liferay.portlet.shopping.model.ShoppingCoupon getCoupon( 202 long couponId) throws PortalException; 203 204 @Override 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public com.liferay.portal.model.PersistedModel getPersistedModel( 207 java.io.Serializable primaryKeyObj) throws PortalException; 208 209 /** 210 * Returns the shopping coupon with the primary key. 211 * 212 * @param couponId the primary key of the shopping coupon 213 * @return the shopping coupon 214 * @throws PortalException if a shopping coupon with the primary key could not be found 215 */ 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public com.liferay.portlet.shopping.model.ShoppingCoupon getShoppingCoupon( 218 long couponId) throws PortalException; 219 220 /** 221 * Returns a range of all the shopping coupons. 222 * 223 * <p> 224 * 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. 225 * </p> 226 * 227 * @param start the lower bound of the range of shopping coupons 228 * @param end the upper bound of the range of shopping coupons (not inclusive) 229 * @return the range of shopping coupons 230 */ 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> getShoppingCoupons( 233 int start, int end); 234 235 /** 236 * Returns the number of shopping coupons. 237 * 238 * @return the number of shopping coupons 239 */ 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public int getShoppingCouponsCount(); 242 243 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 244 public java.util.List<com.liferay.portlet.shopping.model.ShoppingCoupon> search( 245 long groupId, long companyId, java.lang.String code, boolean active, 246 java.lang.String discountType, boolean andOperator, int start, int end); 247 248 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 249 public int searchCount(long groupId, long companyId, java.lang.String code, 250 boolean active, java.lang.String discountType, boolean andOperator); 251 252 /** 253 * Sets the Spring bean ID for this bean. 254 * 255 * @param beanIdentifier the Spring bean ID for this bean 256 */ 257 public void setBeanIdentifier(java.lang.String beanIdentifier); 258 259 public com.liferay.portlet.shopping.model.ShoppingCoupon updateCoupon( 260 long userId, long couponId, java.lang.String name, 261 java.lang.String description, int startDateMonth, int startDateDay, 262 int startDateYear, int startDateHour, int startDateMinute, 263 int endDateMonth, int endDateDay, int endDateYear, int endDateHour, 264 int endDateMinute, boolean neverExpire, boolean active, 265 java.lang.String limitCategories, java.lang.String limitSkus, 266 double minOrder, double discount, java.lang.String discountType, 267 com.liferay.portal.service.ServiceContext serviceContext) 268 throws PortalException; 269 270 /** 271 * Updates the shopping coupon in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 272 * 273 * @param shoppingCoupon the shopping coupon 274 * @return the shopping coupon that was updated 275 */ 276 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 277 public com.liferay.portlet.shopping.model.ShoppingCoupon updateShoppingCoupon( 278 com.liferay.portlet.shopping.model.ShoppingCoupon shoppingCoupon); 279 }