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 ShoppingItemField. 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 ShoppingItemFieldLocalServiceUtil 036 * @see com.liferay.portlet.shopping.service.base.ShoppingItemFieldLocalServiceBaseImpl 037 * @see com.liferay.portlet.shopping.service.impl.ShoppingItemFieldLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface ShoppingItemFieldLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link ShoppingItemFieldLocalServiceUtil} to access the shopping item field local service. Add custom service methods to {@link com.liferay.portlet.shopping.service.impl.ShoppingItemFieldLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the shopping item field to the database. Also notifies the appropriate model listeners. 053 * 054 * @param shoppingItemField the shopping item field 055 * @return the shopping item field that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.portlet.shopping.model.ShoppingItemField addShoppingItemField( 059 com.liferay.portlet.shopping.model.ShoppingItemField shoppingItemField); 060 061 /** 062 * Creates a new shopping item field with the primary key. Does not add the shopping item field to the database. 063 * 064 * @param itemFieldId the primary key for the new shopping item field 065 * @return the new shopping item field 066 */ 067 public com.liferay.portlet.shopping.model.ShoppingItemField createShoppingItemField( 068 long itemFieldId); 069 070 /** 071 * @throws PortalException 072 */ 073 @Override 074 public com.liferay.portal.model.PersistedModel deletePersistedModel( 075 com.liferay.portal.model.PersistedModel persistedModel) 076 throws com.liferay.portal.kernel.exception.PortalException; 077 078 /** 079 * Deletes the shopping item field with the primary key from the database. Also notifies the appropriate model listeners. 080 * 081 * @param itemFieldId the primary key of the shopping item field 082 * @return the shopping item field that was removed 083 * @throws PortalException if a shopping item field with the primary key could not be found 084 */ 085 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 086 public com.liferay.portlet.shopping.model.ShoppingItemField deleteShoppingItemField( 087 long itemFieldId) 088 throws com.liferay.portal.kernel.exception.PortalException; 089 090 /** 091 * Deletes the shopping item field from the database. Also notifies the appropriate model listeners. 092 * 093 * @param shoppingItemField the shopping item field 094 * @return the shopping item field that was removed 095 */ 096 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 097 public com.liferay.portlet.shopping.model.ShoppingItemField deleteShoppingItemField( 098 com.liferay.portlet.shopping.model.ShoppingItemField shoppingItemField); 099 100 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 101 102 /** 103 * Performs a dynamic query on the database and returns the matching rows. 104 * 105 * @param dynamicQuery the dynamic query 106 * @return the matching rows 107 */ 108 public <T> java.util.List<T> dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 110 111 /** 112 * Performs a dynamic query on the database and returns a range of the matching rows. 113 * 114 * <p> 115 * 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.ShoppingItemFieldModelImpl}. 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. 116 * </p> 117 * 118 * @param dynamicQuery the dynamic query 119 * @param start the lower bound of the range of model instances 120 * @param end the upper bound of the range of model instances (not inclusive) 121 * @return the range of matching rows 122 */ 123 public <T> java.util.List<T> dynamicQuery( 124 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 125 int end); 126 127 /** 128 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 129 * 130 * <p> 131 * 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.ShoppingItemFieldModelImpl}. 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 138 * @return the ordered 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 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 144 145 /** 146 * Returns the number of rows matching the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows matching the dynamic query 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 153 154 /** 155 * Returns the number of rows matching the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @param projection the projection to apply to the query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 163 com.liferay.portal.kernel.dao.orm.Projection projection); 164 165 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 166 public com.liferay.portlet.shopping.model.ShoppingItemField fetchShoppingItemField( 167 long itemFieldId); 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 171 172 /** 173 * Returns the Spring bean ID for this bean. 174 * 175 * @return the Spring bean ID for this bean 176 */ 177 public java.lang.String getBeanIdentifier(); 178 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> getItemFields( 181 long itemId); 182 183 @Override 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public com.liferay.portal.model.PersistedModel getPersistedModel( 186 java.io.Serializable primaryKeyObj) 187 throws com.liferay.portal.kernel.exception.PortalException; 188 189 /** 190 * Returns the shopping item field with the primary key. 191 * 192 * @param itemFieldId the primary key of the shopping item field 193 * @return the shopping item field 194 * @throws PortalException if a shopping item field with the primary key could not be found 195 */ 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portlet.shopping.model.ShoppingItemField getShoppingItemField( 198 long itemFieldId) 199 throws com.liferay.portal.kernel.exception.PortalException; 200 201 /** 202 * Returns a range of all the shopping item fields. 203 * 204 * <p> 205 * 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.ShoppingItemFieldModelImpl}. 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. 206 * </p> 207 * 208 * @param start the lower bound of the range of shopping item fields 209 * @param end the upper bound of the range of shopping item fields (not inclusive) 210 * @return the range of shopping item fields 211 */ 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> getShoppingItemFields( 214 int start, int end); 215 216 /** 217 * Returns the number of shopping item fields. 218 * 219 * @return the number of shopping item fields 220 */ 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public int getShoppingItemFieldsCount(); 223 224 /** 225 * Sets the Spring bean ID for this bean. 226 * 227 * @param beanIdentifier the Spring bean ID for this bean 228 */ 229 public void setBeanIdentifier(java.lang.String beanIdentifier); 230 231 /** 232 * Updates the shopping item field in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 233 * 234 * @param shoppingItemField the shopping item field 235 * @return the shopping item field that was updated 236 */ 237 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 238 public com.liferay.portlet.shopping.model.ShoppingItemField updateShoppingItemField( 239 com.liferay.portlet.shopping.model.ShoppingItemField shoppingItemField); 240 }