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