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 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 portal 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 PortalPreferencesLocalServiceUtil
032     * @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface PortalPreferencesLocalService extends BaseLocalService,
039            PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link PortalPreferencesLocalServiceUtil} to access the portal preferences local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the portal preferences to the database. Also notifies the appropriate model listeners.
048            *
049            * @param portalPreferences the portal preferences
050            * @return the portal preferences that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portal.model.PortalPreferences addPortalPreferences(
054                    com.liferay.portal.model.PortalPreferences portalPreferences)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.
059            *
060            * @param portalPreferencesId the primary key for the new portal preferences
061            * @return the new portal preferences
062            */
063            public com.liferay.portal.model.PortalPreferences createPortalPreferences(
064                    long portalPreferencesId);
065    
066            /**
067            * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param portalPreferencesId the primary key of the portal preferences
070            * @return the portal preferences that was removed
071            * @throws PortalException if a portal preferences with the primary key could not be found
072            * @throws SystemException if a system exception occurred
073            */
074            public com.liferay.portal.model.PortalPreferences deletePortalPreferences(
075                    long portalPreferencesId)
076                    throws com.liferay.portal.kernel.exception.PortalException,
077                            com.liferay.portal.kernel.exception.SystemException;
078    
079            /**
080            * Deletes the portal preferences from the database. Also notifies the appropriate model listeners.
081            *
082            * @param portalPreferences the portal preferences
083            * @return the portal preferences that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public com.liferay.portal.model.PortalPreferences deletePortalPreferences(
087                    com.liferay.portal.model.PortalPreferences portalPreferences)
088                    throws com.liferay.portal.kernel.exception.SystemException;
089    
090            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException;
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException;
121    
122            /**
123            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
124            *
125            * <p>
126            * 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.
127            * </p>
128            *
129            * @param dynamicQuery the dynamic query
130            * @param start the lower bound of the range of model instances
131            * @param end the upper bound of the range of model instances (not inclusive)
132            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
133            * @return the ordered range of matching rows
134            * @throws SystemException if a system exception occurred
135            */
136            @SuppressWarnings("rawtypes")
137            public java.util.List dynamicQuery(
138                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
139                    int end,
140                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
141                    throws com.liferay.portal.kernel.exception.SystemException;
142    
143            /**
144            * Returns the number of rows that match the dynamic query.
145            *
146            * @param dynamicQuery the dynamic query
147            * @return the number of rows that match the dynamic query
148            * @throws SystemException if a system exception occurred
149            */
150            public long dynamicQueryCount(
151                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portal.model.PortalPreferences fetchPortalPreferences(
156                    long portalPreferencesId)
157                    throws com.liferay.portal.kernel.exception.SystemException;
158    
159            /**
160            * Returns the portal preferences with the primary key.
161            *
162            * @param portalPreferencesId the primary key of the portal preferences
163            * @return the portal preferences
164            * @throws PortalException if a portal preferences with the primary key could not be found
165            * @throws SystemException if a system exception occurred
166            */
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public com.liferay.portal.model.PortalPreferences getPortalPreferences(
169                    long portalPreferencesId)
170                    throws com.liferay.portal.kernel.exception.PortalException,
171                            com.liferay.portal.kernel.exception.SystemException;
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portal.model.PersistedModel getPersistedModel(
175                    java.io.Serializable primaryKeyObj)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException;
178    
179            /**
180            * Returns a range of all the portal preferenceses.
181            *
182            * <p>
183            * 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.
184            * </p>
185            *
186            * @param start the lower bound of the range of portal preferenceses
187            * @param end the upper bound of the range of portal preferenceses (not inclusive)
188            * @return the range of portal preferenceses
189            * @throws SystemException if a system exception occurred
190            */
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public java.util.List<com.liferay.portal.model.PortalPreferences> getPortalPreferenceses(
193                    int start, int end)
194                    throws com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Returns the number of portal preferenceses.
198            *
199            * @return the number of portal preferenceses
200            * @throws SystemException if a system exception occurred
201            */
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public int getPortalPreferencesesCount()
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
208            *
209            * @param portalPreferences the portal preferences
210            * @return the portal preferences that was updated
211            * @throws SystemException if a system exception occurred
212            */
213            public com.liferay.portal.model.PortalPreferences updatePortalPreferences(
214                    com.liferay.portal.model.PortalPreferences portalPreferences)
215                    throws com.liferay.portal.kernel.exception.SystemException;
216    
217            /**
218            * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
219            *
220            * @param portalPreferences the portal preferences
221            * @param merge whether to merge the portal 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.
222            * @return the portal preferences that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public com.liferay.portal.model.PortalPreferences updatePortalPreferences(
226                    com.liferay.portal.model.PortalPreferences portalPreferences,
227                    boolean merge)
228                    throws com.liferay.portal.kernel.exception.SystemException;
229    
230            /**
231            * Returns the Spring bean ID for this bean.
232            *
233            * @return the Spring bean ID for this bean
234            */
235            public java.lang.String getBeanIdentifier();
236    
237            /**
238            * Sets the Spring bean ID for this bean.
239            *
240            * @param beanIdentifier the Spring bean ID for this bean
241            */
242            public void setBeanIdentifier(java.lang.String beanIdentifier);
243    
244            public com.liferay.portal.model.PortalPreferences addPortalPreferences(
245                    long companyId, long ownerId, int ownerType,
246                    java.lang.String defaultPreferences)
247                    throws com.liferay.portal.kernel.exception.SystemException;
248    
249            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
250            public javax.portlet.PortletPreferences getPreferences(long companyId,
251                    long ownerId, int ownerType)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public javax.portlet.PortletPreferences getPreferences(long companyId,
256                    long ownerId, int ownerType, java.lang.String defaultPreferences)
257                    throws com.liferay.portal.kernel.exception.SystemException;
258    
259            public com.liferay.portal.model.PortalPreferences updatePreferences(
260                    long ownerId, int ownerType,
261                    com.liferay.portlet.PortalPreferences portalPreferences)
262                    throws com.liferay.portal.kernel.exception.SystemException;
263    
264            public com.liferay.portal.model.PortalPreferences updatePreferences(
265                    long ownerId, int ownerType, java.lang.String xml)
266                    throws com.liferay.portal.kernel.exception.SystemException;
267    }