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