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 PortletPreferences. 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 PortletPreferencesLocalServiceUtil
034     * @see com.liferay.portal.service.base.PortletPreferencesLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface PortletPreferencesLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link PortletPreferencesLocalServiceUtil} to access the portlet preferences local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
049                    long companyId, long ownerId, int ownerType, long plid,
050                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
051                    java.lang.String defaultPreferences);
052    
053            /**
054            * Adds the portlet preferences to the database. Also notifies the appropriate model listeners.
055            *
056            * @param portletPreferences the portlet preferences
057            * @return the portlet preferences that was added
058            */
059            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
060            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
061                    com.liferay.portal.model.PortletPreferences portletPreferences);
062    
063            /**
064            * Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.
065            *
066            * @param portletPreferencesId the primary key for the new portlet preferences
067            * @return the new portlet preferences
068            */
069            public com.liferay.portal.model.PortletPreferences createPortletPreferences(
070                    long portletPreferencesId);
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            public void deletePortletPreferences(long ownerId, int ownerType, long plid);
081    
082            public void deletePortletPreferences(long ownerId, int ownerType,
083                    long plid, java.lang.String portletId) throws PortalException;
084    
085            /**
086            * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
087            *
088            * @param portletPreferences the portlet preferences
089            * @return the portlet preferences that was removed
090            */
091            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
092            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
093                    com.liferay.portal.model.PortletPreferences portletPreferences);
094    
095            /**
096            * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.
097            *
098            * @param portletPreferencesId the primary key of the portlet preferences
099            * @return the portlet preferences that was removed
100            * @throws PortalException if a portlet preferences with the primary key could not be found
101            */
102            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
103            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
104                    long portletPreferencesId) throws PortalException;
105    
106            public void deletePortletPreferencesByPlid(long plid);
107    
108            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
109    
110            /**
111            * Performs a dynamic query on the database and returns the matching rows.
112            *
113            * @param dynamicQuery the dynamic query
114            * @return the matching rows
115            */
116            public <T> java.util.List<T> dynamicQuery(
117                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
118    
119            /**
120            * Performs a dynamic query on the database and returns a range of the matching rows.
121            *
122            * <p>
123            * 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.PortletPreferencesModelImpl}. 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.
124            * </p>
125            *
126            * @param dynamicQuery the dynamic query
127            * @param start the lower bound of the range of model instances
128            * @param end the upper bound of the range of model instances (not inclusive)
129            * @return the range of matching rows
130            */
131            public <T> java.util.List<T> dynamicQuery(
132                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
133                    int end);
134    
135            /**
136            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
137            *
138            * <p>
139            * 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.PortletPreferencesModelImpl}. 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.
140            * </p>
141            *
142            * @param dynamicQuery the dynamic query
143            * @param start the lower bound of the range of model instances
144            * @param end the upper bound of the range of model instances (not inclusive)
145            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
146            * @return the ordered range of matching rows
147            */
148            public <T> java.util.List<T> dynamicQuery(
149                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
150                    int end,
151                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
152    
153            /**
154            * Returns the number of rows matching the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @return the number of rows matching the dynamic query
158            */
159            public long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
161    
162            /**
163            * Returns the number of rows matching the dynamic query.
164            *
165            * @param dynamicQuery the dynamic query
166            * @param projection the projection to apply to the query
167            * @return the number of rows matching the dynamic query
168            */
169            public long dynamicQueryCount(
170                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
171                    com.liferay.portal.kernel.dao.orm.Projection projection);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.PortletPreferences fetchPortletPreferences(
175                    long portletPreferencesId);
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public javax.portlet.PortletPreferences fetchPreferences(long companyId,
179                    long ownerId, int ownerType, long plid, java.lang.String portletId);
180    
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public javax.portlet.PortletPreferences fetchPreferences(
183                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds);
184    
185            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
186            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
187    
188            @com.liferay.portal.kernel.spring.aop.Skip
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public javax.portlet.PortletPreferences getDefaultPreferences(
191                    long companyId, java.lang.String portletId);
192    
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
195    
196            /**
197            * Returns the OSGi service identifier.
198            *
199            * @return the OSGi service identifier
200            */
201            public java.lang.String getOSGiServiceIdentifier();
202    
203            @Override
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public com.liferay.portal.model.PersistedModel getPersistedModel(
206                    java.io.Serializable primaryKeyObj) throws PortalException;
207    
208            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
209            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences();
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
213                    long companyId, long groupId, long ownerId, int ownerType,
214                    java.lang.String portletId, boolean privateLayout);
215    
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
218                    long ownerId, int ownerType, long plid);
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
222                    long ownerId, int ownerType, long plid, java.lang.String portletId)
223                    throws PortalException;
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
227                    int ownerType, long plid, java.lang.String portletId);
228    
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
231                    long plid, java.lang.String portletId);
232    
233            /**
234            * Returns the portlet preferences with the primary key.
235            *
236            * @param portletPreferencesId the primary key of the portlet preferences
237            * @return the portlet preferences
238            * @throws PortalException if a portlet preferences with the primary key could not be found
239            */
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
242                    long portletPreferencesId) throws PortalException;
243    
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
246                    long plid);
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public long getPortletPreferencesCount(long ownerId, int ownerType,
250                    long plid, com.liferay.portal.model.Portlet portlet,
251                    boolean excludeDefaultPreferences);
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public long getPortletPreferencesCount(long ownerId, int ownerType,
255                    java.lang.String portletId, boolean excludeDefaultPreferences);
256    
257            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
258            public long getPortletPreferencesCount(int ownerType, long plid,
259                    java.lang.String portletId);
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public long getPortletPreferencesCount(int ownerType,
263                    java.lang.String portletId);
264    
265            /**
266            * Returns a range of all the portlet preferenceses.
267            *
268            * <p>
269            * 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.PortletPreferencesModelImpl}. 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.
270            * </p>
271            *
272            * @param start the lower bound of the range of portlet preferenceses
273            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
274            * @return the range of portlet preferenceses
275            */
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
278                    int start, int end);
279    
280            /**
281            * Returns the number of portlet preferenceses.
282            *
283            * @return the number of portlet preferenceses
284            */
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public int getPortletPreferencesesCount();
287    
288            @com.liferay.portal.kernel.spring.aop.Retry(acceptor = com.liferay.portal.service.ExceptionRetryAcceptor.class, properties =  {
289                    @com.liferay.portal.kernel.spring.aop.Property(name = ExceptionRetryAcceptor.EXCEPTION_NAME, value = "org.springframework.dao.DataIntegrityViolationException")
290            }
291            )
292            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
293            public javax.portlet.PortletPreferences getPreferences(long companyId,
294                    long ownerId, int ownerType, long plid, java.lang.String portletId);
295    
296            @com.liferay.portal.kernel.spring.aop.Retry(acceptor = com.liferay.portal.service.ExceptionRetryAcceptor.class, properties =  {
297                    @com.liferay.portal.kernel.spring.aop.Property(name = ExceptionRetryAcceptor.EXCEPTION_NAME, value = "org.springframework.dao.DataIntegrityViolationException")
298            }
299            )
300            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
301            public javax.portlet.PortletPreferences getPreferences(long companyId,
302                    long ownerId, int ownerType, long plid, java.lang.String portletId,
303                    java.lang.String defaultPreferences);
304    
305            @com.liferay.portal.kernel.spring.aop.Retry(acceptor = com.liferay.portal.service.ExceptionRetryAcceptor.class, properties =  {
306                    @com.liferay.portal.kernel.spring.aop.Property(name = ExceptionRetryAcceptor.EXCEPTION_NAME, value = "org.springframework.dao.DataIntegrityViolationException")
307            }
308            )
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public javax.portlet.PortletPreferences getPreferences(
311                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds);
312    
313            @com.liferay.portal.kernel.spring.aop.Retry(acceptor = com.liferay.portal.service.ExceptionRetryAcceptor.class, properties =  {
314                    @com.liferay.portal.kernel.spring.aop.Property(name = ExceptionRetryAcceptor.EXCEPTION_NAME, value = "org.springframework.dao.DataIntegrityViolationException")
315            }
316            )
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public javax.portlet.PortletPreferences getStrictPreferences(
319                    long companyId, long ownerId, int ownerType, long plid,
320                    java.lang.String portletId);
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public javax.portlet.PortletPreferences getStrictPreferences(
324                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds);
325    
326            /**
327            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
328            *
329            * @param portletPreferences the portlet preferences
330            * @return the portlet preferences that was updated
331            */
332            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
333            public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
334                    com.liferay.portal.model.PortletPreferences portletPreferences);
335    
336            public com.liferay.portal.model.PortletPreferences updatePreferences(
337                    long ownerId, int ownerType, long plid, java.lang.String portletId,
338                    javax.portlet.PortletPreferences portletPreferences);
339    
340            public com.liferay.portal.model.PortletPreferences updatePreferences(
341                    long ownerId, int ownerType, long plid, java.lang.String portletId,
342                    java.lang.String xml);
343    }