001    /**
002     * Copyright (c) 2000-2013 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.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    
025    /**
026     * Provides the local service interface for PortletPreferences. Methods of this
027     * service will not have security checks based on the propagated JAAS
028     * credentials because this service can only be accessed from within the same
029     * VM.
030     *
031     * @author Brian Wing Shun Chan
032     * @see PortletPreferencesLocalServiceUtil
033     * @see com.liferay.portal.service.base.PortletPreferencesLocalServiceBaseImpl
034     * @see com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl
035     * @generated
036     */
037    @ProviderType
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface PortletPreferencesLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the portlet preferences to the database. Also notifies the appropriate model listeners.
050            *
051            * @param portletPreferences the portlet preferences
052            * @return the portlet preferences that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
056                    com.liferay.portal.model.PortletPreferences portletPreferences)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.
061            *
062            * @param portletPreferencesId the primary key for the new portlet preferences
063            * @return the new portlet preferences
064            */
065            public com.liferay.portal.model.PortletPreferences createPortletPreferences(
066                    long portletPreferencesId);
067    
068            /**
069            * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param portletPreferencesId the primary key of the portlet preferences
072            * @return the portlet preferences that was removed
073            * @throws PortalException if a portlet preferences with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
077                    long portletPreferencesId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
083            *
084            * @param portletPreferences the portlet preferences
085            * @return the portlet preferences that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
089                    com.liferay.portal.model.PortletPreferences portletPreferences)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            /**
157            * Returns the number of rows that match the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @param projection the projection to apply to the query
161            * @return the number of rows that match the dynamic query
162            * @throws SystemException if a system exception occurred
163            */
164            public long dynamicQueryCount(
165                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
166                    com.liferay.portal.kernel.dao.orm.Projection projection)
167                    throws com.liferay.portal.kernel.exception.SystemException;
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.model.PortletPreferences fetchPortletPreferences(
171                    long portletPreferencesId)
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Returns the portlet preferences with the primary key.
176            *
177            * @param portletPreferencesId the primary key of the portlet preferences
178            * @return the portlet preferences
179            * @throws PortalException if a portlet preferences with the primary key could not be found
180            * @throws SystemException if a system exception occurred
181            */
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
184                    long portletPreferencesId)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException;
187    
188            @Override
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portal.model.PersistedModel getPersistedModel(
191                    java.io.Serializable primaryKeyObj)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Returns a range of all the portlet preferenceses.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of portlet preferenceses
203            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
204            * @return the range of portlet preferenceses
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
209                    int start, int end)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Returns the number of portlet preferenceses.
214            *
215            * @return the number of portlet preferenceses
216            * @throws SystemException if a system exception occurred
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getPortletPreferencesesCount()
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param portletPreferences the portlet preferences
226            * @return the portlet preferences that was updated
227            * @throws SystemException if a system exception occurred
228            */
229            public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
230                    com.liferay.portal.model.PortletPreferences portletPreferences)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Returns the Spring bean ID for this bean.
235            *
236            * @return the Spring bean ID for this bean
237            */
238            public java.lang.String getBeanIdentifier();
239    
240            /**
241            * Sets the Spring bean ID for this bean.
242            *
243            * @param beanIdentifier the Spring bean ID for this bean
244            */
245            public void setBeanIdentifier(java.lang.String beanIdentifier);
246    
247            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
248                    long companyId, long ownerId, int ownerType, long plid,
249                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
250                    java.lang.String defaultPreferences)
251                    throws com.liferay.portal.kernel.exception.SystemException;
252    
253            public void deletePortletPreferences(long ownerId, int ownerType, long plid)
254                    throws com.liferay.portal.kernel.exception.SystemException;
255    
256            public void deletePortletPreferences(long ownerId, int ownerType,
257                    long plid, java.lang.String portletId)
258                    throws com.liferay.portal.kernel.exception.PortalException,
259                            com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deletePortletPreferencesByPlid(long plid)
262                    throws com.liferay.portal.kernel.exception.SystemException;
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public javax.portlet.PortletPreferences fetchPreferences(long companyId,
266                    long ownerId, int ownerType, long plid, java.lang.String portletId)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public javax.portlet.PortletPreferences fetchPreferences(
271                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public javax.portlet.PortletPreferences getDefaultPreferences(
276                    long companyId, java.lang.String portletId)
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
280            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences()
281                    throws com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
285                    int ownerType, long plid, java.lang.String portletId)
286                    throws com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
290                    long ownerId, int ownerType, long plid)
291                    throws com.liferay.portal.kernel.exception.SystemException;
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
295                    long ownerId, int ownerType, long plid, java.lang.String portletId)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
301                    long companyId, long groupId, long ownerId, int ownerType,
302                    java.lang.String portletId, boolean privateLayout)
303                    throws com.liferay.portal.kernel.exception.SystemException;
304    
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
307                    long plid, java.lang.String portletId)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
312                    long plid) throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public long getPortletPreferencesCount(int ownerType, long plid,
316                    java.lang.String portletId)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public long getPortletPreferencesCount(int ownerType,
321                    java.lang.String portletId)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public long getPortletPreferencesCount(long ownerId, int ownerType,
326                    long plid, com.liferay.portal.model.Portlet portlet,
327                    boolean excludeDefaultPreferences)
328                    throws com.liferay.portal.kernel.exception.SystemException;
329    
330            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
331            public long getPortletPreferencesCount(long ownerId, int ownerType,
332                    java.lang.String portletId, boolean excludeDefaultPreferences)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public javax.portlet.PortletPreferences getPreferences(long companyId,
337                    long ownerId, int ownerType, long plid, java.lang.String portletId)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public javax.portlet.PortletPreferences getPreferences(long companyId,
342                    long ownerId, int ownerType, long plid, java.lang.String portletId,
343                    java.lang.String defaultPreferences)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public javax.portlet.PortletPreferences getPreferences(
348                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public javax.portlet.PortletPreferences getStrictPreferences(
353                    long companyId, long ownerId, int ownerType, long plid,
354                    java.lang.String portletId)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public javax.portlet.PortletPreferences getStrictPreferences(
359                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            public com.liferay.portal.model.PortletPreferences updatePreferences(
363                    long ownerId, int ownerType, long plid, java.lang.String portletId,
364                    javax.portlet.PortletPreferences portletPreferences)
365                    throws com.liferay.portal.kernel.exception.SystemException;
366    
367            public com.liferay.portal.model.PortletPreferences updatePreferences(
368                    long ownerId, int ownerType, long plid, java.lang.String portletId,
369                    java.lang.String xml)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    }