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 com.liferay.portal.kernel.exception.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)
084                    throws com.liferay.portal.kernel.exception.PortalException;
085    
086            /**
087            * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
088            *
089            * @param portletPreferences the portlet preferences
090            * @return the portlet preferences that was removed
091            */
092            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
093            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
094                    com.liferay.portal.model.PortletPreferences portletPreferences);
095    
096            /**
097            * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.
098            *
099            * @param portletPreferencesId the primary key of the portlet preferences
100            * @return the portlet preferences that was removed
101            * @throws PortalException if a portlet preferences with the primary key could not be found
102            */
103            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
104            public com.liferay.portal.model.PortletPreferences deletePortletPreferences(
105                    long portletPreferencesId)
106                    throws com.liferay.portal.kernel.exception.PortalException;
107    
108            public void deletePortletPreferencesByPlid(long plid);
109    
110            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
111    
112            /**
113            * Performs a dynamic query on the database and returns the matching rows.
114            *
115            * @param dynamicQuery the dynamic query
116            * @return the matching rows
117            */
118            public <T> java.util.List<T> dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
120    
121            /**
122            * Performs a dynamic query on the database and returns a range of the matching rows.
123            *
124            * <p>
125            * 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.
126            * </p>
127            *
128            * @param dynamicQuery the dynamic query
129            * @param start the lower bound of the range of model instances
130            * @param end the upper bound of the range of model instances (not inclusive)
131            * @return the range of matching rows
132            */
133            public <T> java.util.List<T> dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end);
136    
137            /**
138            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
139            *
140            * <p>
141            * 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.
142            * </p>
143            *
144            * @param dynamicQuery the dynamic query
145            * @param start the lower bound of the range of model instances
146            * @param end the upper bound of the range of model instances (not inclusive)
147            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
148            * @return the ordered range of matching rows
149            */
150            public <T> java.util.List<T> dynamicQuery(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
152                    int end,
153                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
154    
155            /**
156            * Returns the number of rows matching the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows matching the dynamic query
160            */
161            public long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
163    
164            /**
165            * Returns the number of rows matching the dynamic query.
166            *
167            * @param dynamicQuery the dynamic query
168            * @param projection the projection to apply to the query
169            * @return the number of rows matching the dynamic query
170            */
171            public long dynamicQueryCount(
172                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
173                    com.liferay.portal.kernel.dao.orm.Projection projection);
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PortletPreferences fetchPortletPreferences(
177                    long portletPreferencesId);
178    
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public javax.portlet.PortletPreferences fetchPreferences(long companyId,
181                    long ownerId, int ownerType, long plid, java.lang.String portletId);
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public javax.portlet.PortletPreferences fetchPreferences(
185                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds);
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
189    
190            /**
191            * Returns the Spring bean ID for this bean.
192            *
193            * @return the Spring bean ID for this bean
194            */
195            public java.lang.String getBeanIdentifier();
196    
197            @com.liferay.portal.kernel.spring.aop.Skip
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public javax.portlet.PortletPreferences getDefaultPreferences(
200                    long companyId, java.lang.String portletId);
201    
202            @Override
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public com.liferay.portal.model.PersistedModel getPersistedModel(
205                    java.io.Serializable primaryKeyObj)
206                    throws com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.exception.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)
243                    throws com.liferay.portal.kernel.exception.PortalException;
244    
245            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
246            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
247                    long plid);
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public long getPortletPreferencesCount(long ownerId, int ownerType,
251                    long plid, com.liferay.portal.model.Portlet portlet,
252                    boolean excludeDefaultPreferences);
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public long getPortletPreferencesCount(long ownerId, int ownerType,
256                    java.lang.String portletId, boolean excludeDefaultPreferences);
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public long getPortletPreferencesCount(int ownerType, long plid,
260                    java.lang.String portletId);
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public long getPortletPreferencesCount(int ownerType,
264                    java.lang.String portletId);
265    
266            /**
267            * Returns a range of all the portlet preferenceses.
268            *
269            * <p>
270            * 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.
271            * </p>
272            *
273            * @param start the lower bound of the range of portlet preferenceses
274            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
275            * @return the range of portlet preferenceses
276            */
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
279                    int start, int end);
280    
281            /**
282            * Returns the number of portlet preferenceses.
283            *
284            * @return the number of portlet preferenceses
285            */
286            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
287            public int getPortletPreferencesesCount();
288    
289            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290            public javax.portlet.PortletPreferences getPreferences(long companyId,
291                    long ownerId, int ownerType, long plid, java.lang.String portletId);
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public javax.portlet.PortletPreferences getPreferences(long companyId,
295                    long ownerId, int ownerType, long plid, java.lang.String portletId,
296                    java.lang.String defaultPreferences);
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public javax.portlet.PortletPreferences getPreferences(
300                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds);
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public javax.portlet.PortletPreferences getStrictPreferences(
304                    long companyId, long ownerId, int ownerType, long plid,
305                    java.lang.String portletId);
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public javax.portlet.PortletPreferences getStrictPreferences(
309                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds);
310    
311            /**
312            * Sets the Spring bean ID for this bean.
313            *
314            * @param beanIdentifier the Spring bean ID for this bean
315            */
316            public void setBeanIdentifier(java.lang.String beanIdentifier);
317    
318            /**
319            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
320            *
321            * @param portletPreferences the portlet preferences
322            * @return the portlet preferences that was updated
323            */
324            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
325            public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
326                    com.liferay.portal.model.PortletPreferences portletPreferences);
327    
328            public com.liferay.portal.model.PortletPreferences updatePreferences(
329                    long ownerId, int ownerType, long plid, java.lang.String portletId,
330                    javax.portlet.PortletPreferences portletPreferences);
331    
332            public com.liferay.portal.model.PortletPreferences updatePreferences(
333                    long ownerId, int ownerType, long plid, java.lang.String portletId,
334                    java.lang.String xml);
335    }