001    /**
002     * Copyright (c) 2000-2011 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            /**
150            * Returns the portlet preferences with the primary key.
151            *
152            * @param portletPreferencesId the primary key of the portlet preferences
153            * @return the portlet preferences
154            * @throws PortalException if a portlet preferences with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
159                    long portletPreferencesId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns a range of all the portlet preferenceses.
171            *
172            * <p>
173            * 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.
174            * </p>
175            *
176            * @param start the lower bound of the range of portlet preferenceses
177            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
178            * @return the range of portlet preferenceses
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
183                    int start, int end)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the number of portlet preferenceses.
188            *
189            * @return the number of portlet preferenceses
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public int getPortletPreferencesesCount()
194                    throws com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
198            *
199            * @param portletPreferences the portlet preferences
200            * @return the portlet preferences that was updated
201            * @throws SystemException if a system exception occurred
202            */
203            public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
204                    com.liferay.portal.model.PortletPreferences portletPreferences)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
209            *
210            * @param portletPreferences the portlet preferences
211            * @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.
212            * @return the portlet preferences that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portal.model.PortletPreferences updatePortletPreferences(
216                    com.liferay.portal.model.PortletPreferences portletPreferences,
217                    boolean merge)
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns the Spring bean ID for this bean.
222            *
223            * @return the Spring bean ID for this bean
224            */
225            public java.lang.String getBeanIdentifier();
226    
227            /**
228            * Sets the Spring bean ID for this bean.
229            *
230            * @param beanIdentifier the Spring bean ID for this bean
231            */
232            public void setBeanIdentifier(java.lang.String beanIdentifier);
233    
234            public com.liferay.portal.model.PortletPreferences addPortletPreferences(
235                    long companyId, long ownerId, int ownerType, long plid,
236                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
237                    java.lang.String defaultPreferences)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            public void deletePortletPreferences(long ownerId, int ownerType, long plid)
241                    throws com.liferay.portal.kernel.exception.SystemException;
242    
243            public void deletePortletPreferences(long ownerId, int ownerType,
244                    long plid, java.lang.String portletId)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public javax.portlet.PortletPreferences getDefaultPreferences(
250                    long companyId, java.lang.String portletId)
251                    throws com.liferay.portal.kernel.exception.SystemException;
252    
253            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
254            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences()
255                    throws com.liferay.portal.kernel.exception.SystemException;
256    
257            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
258            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
259                    long ownerId, int ownerType, long plid)
260                    throws com.liferay.portal.kernel.exception.SystemException;
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public com.liferay.portal.model.PortletPreferences getPortletPreferences(
264                    long ownerId, int ownerType, long plid, java.lang.String portletId)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException;
267    
268            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
269            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
270                    long plid, java.lang.String portletId)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
275                    long plid) throws com.liferay.portal.kernel.exception.SystemException;
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public javax.portlet.PortletPreferences getPreferences(long companyId,
279                    long ownerId, int ownerType, long plid, java.lang.String portletId)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public javax.portlet.PortletPreferences getPreferences(long companyId,
284                    long ownerId, int ownerType, long plid, java.lang.String portletId,
285                    java.lang.String defaultPreferences)
286                    throws com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public javax.portlet.PortletPreferences getPreferences(
290                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
291                    throws com.liferay.portal.kernel.exception.SystemException;
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public javax.portlet.PortletPreferences getStrictPreferences(
295                    long companyId, long ownerId, int ownerType, long plid,
296                    java.lang.String portletId)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public javax.portlet.PortletPreferences getStrictPreferences(
301                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            public com.liferay.portal.model.PortletPreferences updatePreferences(
305                    long ownerId, int ownerType, long plid, java.lang.String portletId,
306                    javax.portlet.PortletPreferences portletPreferences)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            public com.liferay.portal.model.PortletPreferences updatePreferences(
310                    long ownerId, int ownerType, long plid, java.lang.String portletId,
311                    java.lang.String xml)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    }