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.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    
049            /**
050            * Adds the portlet preferences to the database. Also notifies the appropriate model listeners.
051            *
052            * @param portletPreferences the portlet preferences
053            * @return the portlet preferences that was added
054            * @throws SystemException if a system exception occurred
055            */
056            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
057            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
058                    com.liferay.portal.model.PortletPreferences portletPreferences)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.
063            *
064            * @param portletPreferencesId the primary key for the new portlet preferences
065            * @return the new portlet preferences
066            */
067            public com.liferay.portal.model.PortletPreferences createPortletPreferences(
068                    long portletPreferencesId);
069    
070            /**
071            * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param portletPreferencesId the primary key of the portlet preferences
074            * @return the portlet preferences that was removed
075            * @throws PortalException if a portlet preferences with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
079            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
080                    long portletPreferencesId)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
086            *
087            * @param portletPreferences the portlet preferences
088            * @return the portlet preferences that was removed
089            * @throws SystemException if a system exception occurred
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                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
097    
098            /**
099            * Performs a dynamic query on the database and returns the matching rows.
100            *
101            * @param dynamicQuery the dynamic query
102            * @return the matching rows
103            * @throws SystemException if a system exception occurred
104            */
105            @SuppressWarnings("rawtypes")
106            public java.util.List dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
108                    throws com.liferay.portal.kernel.exception.SystemException;
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.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.
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            * @throws SystemException if a system exception occurred
122            */
123            @SuppressWarnings("rawtypes")
124            public java.util.List dynamicQuery(
125                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
126                    int end) throws com.liferay.portal.kernel.exception.SystemException;
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.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.
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            * @throws SystemException if a system exception occurred
141            */
142            @SuppressWarnings("rawtypes")
143            public java.util.List dynamicQuery(
144                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
145                    int end,
146                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the number of rows that match the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows that match the dynamic query
154            * @throws SystemException if a system exception occurred
155            */
156            public long dynamicQueryCount(
157                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
158                    throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the number of rows that match the dynamic query.
162            *
163            * @param dynamicQuery the dynamic query
164            * @param projection the projection to apply to the query
165            * @return the number of rows that match the dynamic query
166            * @throws SystemException if a system exception occurred
167            */
168            public long dynamicQueryCount(
169                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
170                    com.liferay.portal.kernel.dao.orm.Projection projection)
171                    throws com.liferay.portal.kernel.exception.SystemException;
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.PortletPreferences fetchPortletPreferences(
175                    long portletPreferencesId)
176                    throws com.liferay.portal.kernel.exception.SystemException;
177    
178            /**
179            * Returns the portlet preferences with the primary key.
180            *
181            * @param portletPreferencesId the primary key of the portlet preferences
182            * @return the portlet preferences
183            * @throws PortalException if a portlet preferences with the primary key could not be found
184            * @throws SystemException if a system exception occurred
185            */
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
188                    long portletPreferencesId)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException;
191    
192            @Override
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public com.liferay.portal.model.PersistedModel getPersistedModel(
195                    java.io.Serializable primaryKeyObj)
196                    throws com.liferay.portal.kernel.exception.PortalException,
197                            com.liferay.portal.kernel.exception.SystemException;
198    
199            /**
200            * Returns a range of all the portlet preferenceses.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of portlet preferenceses
207            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
208            * @return the range of portlet preferenceses
209            * @throws SystemException if a system exception occurred
210            */
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
213                    int start, int end)
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Returns the number of portlet preferenceses.
218            *
219            * @return the number of portlet preferenceses
220            * @throws SystemException if a system exception occurred
221            */
222            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223            public int getPortletPreferencesesCount()
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
228            *
229            * @param portletPreferences the portlet preferences
230            * @return the portlet preferences that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
234            public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
235                    com.liferay.portal.model.PortletPreferences portletPreferences)
236                    throws com.liferay.portal.kernel.exception.SystemException;
237    
238            /**
239            * Returns the Spring bean ID for this bean.
240            *
241            * @return the Spring bean ID for this bean
242            */
243            public java.lang.String getBeanIdentifier();
244    
245            /**
246            * Sets the Spring bean ID for this bean.
247            *
248            * @param beanIdentifier the Spring bean ID for this bean
249            */
250            public void setBeanIdentifier(java.lang.String beanIdentifier);
251    
252            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
253                    long companyId, long ownerId, int ownerType, long plid,
254                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
255                    java.lang.String defaultPreferences)
256                    throws com.liferay.portal.kernel.exception.SystemException;
257    
258            public void deletePortletPreferences(long ownerId, int ownerType, long plid)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deletePortletPreferences(long ownerId, int ownerType,
262                    long plid, java.lang.String portletId)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException;
265    
266            public void deletePortletPreferencesByPlid(long plid)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public javax.portlet.PortletPreferences fetchPreferences(long companyId,
271                    long ownerId, int ownerType, long plid, java.lang.String portletId)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public javax.portlet.PortletPreferences fetchPreferences(
276                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            @com.liferay.portal.kernel.spring.aop.Skip
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public javax.portlet.PortletPreferences getDefaultPreferences(
282                    long companyId, java.lang.String portletId)
283                    throws com.liferay.portal.kernel.exception.SystemException;
284    
285            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
286            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences()
287                    throws com.liferay.portal.kernel.exception.SystemException;
288    
289            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
291                    int ownerType, long plid, java.lang.String portletId)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
296                    long ownerId, int ownerType, long plid)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
301                    long ownerId, int ownerType, long plid, java.lang.String portletId)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            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 companyId, long groupId, long ownerId, int ownerType,
308                    java.lang.String portletId, boolean privateLayout)
309                    throws com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
313                    long plid, java.lang.String portletId)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
318                    long plid) throws com.liferay.portal.kernel.exception.SystemException;
319    
320            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
321            public long getPortletPreferencesCount(int ownerType, long plid,
322                    java.lang.String portletId)
323                    throws com.liferay.portal.kernel.exception.SystemException;
324    
325            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
326            public long getPortletPreferencesCount(int ownerType,
327                    java.lang.String portletId)
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                    long plid, com.liferay.portal.model.Portlet portlet,
333                    boolean excludeDefaultPreferences)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public long getPortletPreferencesCount(long ownerId, int ownerType,
338                    java.lang.String portletId, boolean excludeDefaultPreferences)
339                    throws com.liferay.portal.kernel.exception.SystemException;
340    
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public javax.portlet.PortletPreferences getPreferences(long companyId,
343                    long ownerId, int ownerType, long plid, java.lang.String portletId)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public javax.portlet.PortletPreferences getPreferences(long companyId,
348                    long ownerId, int ownerType, long plid, java.lang.String portletId,
349                    java.lang.String defaultPreferences)
350                    throws com.liferay.portal.kernel.exception.SystemException;
351    
352            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353            public javax.portlet.PortletPreferences getPreferences(
354                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
355                    throws com.liferay.portal.kernel.exception.SystemException;
356    
357            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
358            public javax.portlet.PortletPreferences getStrictPreferences(
359                    long companyId, long ownerId, int ownerType, long plid,
360                    java.lang.String portletId)
361                    throws com.liferay.portal.kernel.exception.SystemException;
362    
363            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
364            public javax.portlet.PortletPreferences getStrictPreferences(
365                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            public com.liferay.portal.model.PortletPreferences updatePreferences(
369                    long ownerId, int ownerType, long plid, java.lang.String portletId,
370                    javax.portlet.PortletPreferences portletPreferences)
371                    throws com.liferay.portal.kernel.exception.SystemException;
372    
373            public com.liferay.portal.model.PortletPreferences updatePreferences(
374                    long ownerId, int ownerType, long plid, java.lang.String portletId,
375                    java.lang.String xml)
376                    throws com.liferay.portal.kernel.exception.SystemException;
377    }