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 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) throws PortalException;
088    
089            /**
090            * Deletes the shopping item field from the database. Also notifies the appropriate model listeners.
091            *
092            * @param shoppingItemField the shopping item field
093            * @return the shopping item field that was removed
094            */
095            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
096            public com.liferay.portlet.shopping.model.ShoppingItemField deleteShoppingItemField(
097                    com.liferay.portlet.shopping.model.ShoppingItemField shoppingItemField);
098    
099            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
100    
101            /**
102            * Performs a dynamic query on the database and returns the matching rows.
103            *
104            * @param dynamicQuery the dynamic query
105            * @return the matching rows
106            */
107            public <T> java.util.List<T> dynamicQuery(
108                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
109    
110            /**
111            * Performs a dynamic query on the database and returns a range of the matching rows.
112            *
113            * <p>
114            * 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.
115            * </p>
116            *
117            * @param dynamicQuery the dynamic query
118            * @param start the lower bound of the range of model instances
119            * @param end the upper bound of the range of model instances (not inclusive)
120            * @return the range of matching rows
121            */
122            public <T> java.util.List<T> dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end);
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            */
139            public <T> java.util.List<T> dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
143    
144            /**
145            * Returns the number of rows matching the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query
148            * @return the number of rows matching the dynamic query
149            */
150            public long dynamicQueryCount(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
152    
153            /**
154            * Returns the number of rows matching the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @param projection the projection to apply to the query
158            * @return the number of rows matching the dynamic query
159            */
160            public long dynamicQueryCount(
161                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
162                    com.liferay.portal.kernel.dao.orm.Projection projection);
163    
164            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165            public com.liferay.portlet.shopping.model.ShoppingItemField fetchShoppingItemField(
166                    long itemFieldId);
167    
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
170    
171            /**
172            * Returns the Spring bean ID for this bean.
173            *
174            * @return the Spring bean ID for this bean
175            */
176            public java.lang.String getBeanIdentifier();
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> getItemFields(
180                    long itemId);
181    
182            @Override
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portal.model.PersistedModel getPersistedModel(
185                    java.io.Serializable primaryKeyObj) throws PortalException;
186    
187            /**
188            * Returns the shopping item field with the primary key.
189            *
190            * @param itemFieldId the primary key of the shopping item field
191            * @return the shopping item field
192            * @throws PortalException if a shopping item field with the primary key could not be found
193            */
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portlet.shopping.model.ShoppingItemField getShoppingItemField(
196                    long itemFieldId) throws PortalException;
197    
198            /**
199            * Returns a range of all the shopping item fields.
200            *
201            * <p>
202            * 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.
203            * </p>
204            *
205            * @param start the lower bound of the range of shopping item fields
206            * @param end the upper bound of the range of shopping item fields (not inclusive)
207            * @return the range of shopping item fields
208            */
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portlet.shopping.model.ShoppingItemField> getShoppingItemFields(
211                    int start, int end);
212    
213            /**
214            * Returns the number of shopping item fields.
215            *
216            * @return the number of shopping item fields
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getShoppingItemFieldsCount();
220    
221            /**
222            * Sets the Spring bean ID for this bean.
223            *
224            * @param beanIdentifier the Spring bean ID for this bean
225            */
226            public void setBeanIdentifier(java.lang.String beanIdentifier);
227    
228            /**
229            * Updates the shopping item field in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
230            *
231            * @param shoppingItemField the shopping item field
232            * @return the shopping item field that was updated
233            */
234            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
235            public com.liferay.portlet.shopping.model.ShoppingItemField updateShoppingItemField(
236                    com.liferay.portlet.shopping.model.ShoppingItemField shoppingItemField);
237    }