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.portal.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    
026    /**
027     * Provides the local service interface for PortletItem. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see PortletItemLocalServiceUtil
034     * @see com.liferay.portal.service.base.PortletItemLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.PortletItemLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface PortletItemLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link PortletItemLocalServiceUtil} to access the portlet item local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletItemLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the portlet item to the database. Also notifies the appropriate model listeners.
051            *
052            * @param portletItem the portlet item
053            * @return the portlet item that was added
054            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.PortletItem addPortletItem(
057                    com.liferay.portal.model.PortletItem portletItem);
058    
059            public com.liferay.portal.model.PortletItem addPortletItem(long userId,
060                    long groupId, java.lang.String name, java.lang.String portletId,
061                    java.lang.String className) throws PortalException;
062    
063            /**
064            * Creates a new portlet item with the primary key. Does not add the portlet item to the database.
065            *
066            * @param portletItemId the primary key for the new portlet item
067            * @return the new portlet item
068            */
069            public com.liferay.portal.model.PortletItem createPortletItem(
070                    long portletItemId);
071    
072            /**
073            * @throws PortalException
074            */
075            @Override
076            public com.liferay.portal.model.PersistedModel deletePersistedModel(
077                    com.liferay.portal.model.PersistedModel persistedModel)
078                    throws PortalException;
079    
080            /**
081            * Deletes the portlet item from the database. Also notifies the appropriate model listeners.
082            *
083            * @param portletItem the portlet item
084            * @return the portlet item that was removed
085            */
086            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
087            public com.liferay.portal.model.PortletItem deletePortletItem(
088                    com.liferay.portal.model.PortletItem portletItem);
089    
090            /**
091            * Deletes the portlet item with the primary key from the database. Also notifies the appropriate model listeners.
092            *
093            * @param portletItemId the primary key of the portlet item
094            * @return the portlet item that was removed
095            * @throws PortalException if a portlet item with the primary key could not be found
096            */
097            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
098            public com.liferay.portal.model.PortletItem deletePortletItem(
099                    long portletItemId) throws PortalException;
100    
101            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
102    
103            /**
104            * Performs a dynamic query on the database and returns the matching rows.
105            *
106            * @param dynamicQuery the dynamic query
107            * @return the matching rows
108            */
109            public <T> java.util.List<T> dynamicQuery(
110                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
111    
112            /**
113            * Performs a dynamic query on the database and returns a range of the matching rows.
114            *
115            * <p>
116            * 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.portal.model.impl.PortletItemModelImpl}. 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.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query
120            * @param start the lower bound of the range of model instances
121            * @param end the upper bound of the range of model instances (not inclusive)
122            * @return the range of matching rows
123            */
124            public <T> java.util.List<T> dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end);
127    
128            /**
129            * Performs a dynamic query on the database and returns an ordered 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.portal.model.impl.PortletItemModelImpl}. 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            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
139            * @return the ordered range of matching rows
140            */
141            public <T> java.util.List<T> dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
145    
146            /**
147            * Returns the number of rows matching the dynamic query.
148            *
149            * @param dynamicQuery the dynamic query
150            * @return the number of rows matching the dynamic query
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
154    
155            /**
156            * Returns the number of rows matching the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @param projection the projection to apply to the query
160            * @return the number of rows matching the dynamic query
161            */
162            public long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
164                    com.liferay.portal.kernel.dao.orm.Projection projection);
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public com.liferay.portal.model.PortletItem fetchPortletItem(
168                    long portletItemId);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
172    
173            /**
174            * Returns the Spring bean ID for this bean.
175            *
176            * @return the Spring bean ID for this bean
177            */
178            public java.lang.String getBeanIdentifier();
179    
180            @Override
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj) throws PortalException;
184    
185            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
186            public com.liferay.portal.model.PortletItem getPortletItem(long groupId,
187                    java.lang.String name, java.lang.String portletId,
188                    java.lang.String className) throws PortalException;
189    
190            /**
191            * Returns the portlet item with the primary key.
192            *
193            * @param portletItemId the primary key of the portlet item
194            * @return the portlet item
195            * @throws PortalException if a portlet item with the primary key could not be found
196            */
197            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
198            public com.liferay.portal.model.PortletItem getPortletItem(
199                    long portletItemId) throws PortalException;
200    
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public java.util.List<com.liferay.portal.model.PortletItem> getPortletItems(
203                    long groupId, java.lang.String className);
204    
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public java.util.List<com.liferay.portal.model.PortletItem> getPortletItems(
207                    long groupId, java.lang.String portletId, java.lang.String className);
208    
209            /**
210            * Returns a range of all the portlet items.
211            *
212            * <p>
213            * 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.portal.model.impl.PortletItemModelImpl}. 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.
214            * </p>
215            *
216            * @param start the lower bound of the range of portlet items
217            * @param end the upper bound of the range of portlet items (not inclusive)
218            * @return the range of portlet items
219            */
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public java.util.List<com.liferay.portal.model.PortletItem> getPortletItems(
222                    int start, int end);
223    
224            /**
225            * Returns the number of portlet items.
226            *
227            * @return the number of portlet items
228            */
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public int getPortletItemsCount();
231    
232            /**
233            * Sets the Spring bean ID for this bean.
234            *
235            * @param beanIdentifier the Spring bean ID for this bean
236            */
237            public void setBeanIdentifier(java.lang.String beanIdentifier);
238    
239            /**
240            * Updates the portlet item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param portletItem the portlet item
243            * @return the portlet item that was updated
244            */
245            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
246            public com.liferay.portal.model.PortletItem updatePortletItem(
247                    com.liferay.portal.model.PortletItem portletItem);
248    
249            public com.liferay.portal.model.PortletItem updatePortletItem(long userId,
250                    long groupId, java.lang.String name, java.lang.String portletId,
251                    java.lang.String className) throws PortalException;
252    }