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 PortalPreferences. 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 PortalPreferencesLocalServiceUtil
034     * @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface PortalPreferencesLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * 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.
047             */
048    
049            /**
050            * @deprecated As of 6.2.0, replaced by {@link #addPortalPreferences(long,
051            int, String)}
052            */
053            @java.lang.Deprecated
054            public com.liferay.portal.model.PortalPreferences addPortalPreferences(
055                    long companyId, long ownerId, int ownerType,
056                    java.lang.String defaultPreferences);
057    
058            public com.liferay.portal.model.PortalPreferences addPortalPreferences(
059                    long ownerId, int ownerType, java.lang.String defaultPreferences);
060    
061            /**
062            * Adds the portal preferences to the database. Also notifies the appropriate model listeners.
063            *
064            * @param portalPreferences the portal preferences
065            * @return the portal preferences that was added
066            */
067            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
068            public com.liferay.portal.model.PortalPreferences addPortalPreferences(
069                    com.liferay.portal.model.PortalPreferences portalPreferences);
070    
071            /**
072            * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.
073            *
074            * @param portalPreferencesId the primary key for the new portal preferences
075            * @return the new portal preferences
076            */
077            public com.liferay.portal.model.PortalPreferences createPortalPreferences(
078                    long portalPreferencesId);
079    
080            /**
081            * @throws PortalException
082            */
083            @Override
084            public com.liferay.portal.model.PersistedModel deletePersistedModel(
085                    com.liferay.portal.model.PersistedModel persistedModel)
086                    throws com.liferay.portal.kernel.exception.PortalException;
087    
088            /**
089            * Deletes the portal preferences from the database. Also notifies the appropriate model listeners.
090            *
091            * @param portalPreferences the portal preferences
092            * @return the portal preferences that was removed
093            */
094            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
095            public com.liferay.portal.model.PortalPreferences deletePortalPreferences(
096                    com.liferay.portal.model.PortalPreferences portalPreferences);
097    
098            /**
099            * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.
100            *
101            * @param portalPreferencesId the primary key of the portal preferences
102            * @return the portal preferences that was removed
103            * @throws PortalException if a portal preferences with the primary key could not be found
104            */
105            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
106            public com.liferay.portal.model.PortalPreferences deletePortalPreferences(
107                    long portalPreferencesId)
108                    throws com.liferay.portal.kernel.exception.PortalException;
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.PortalPreferencesModelImpl}. 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.PortalPreferencesModelImpl}. 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.PortalPreferences fetchPortalPreferences(
177                    long portalPreferencesId);
178    
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
181    
182            /**
183            * Returns the Spring bean ID for this bean.
184            *
185            * @return the Spring bean ID for this bean
186            */
187            public java.lang.String getBeanIdentifier();
188    
189            @Override
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.model.PersistedModel getPersistedModel(
192                    java.io.Serializable primaryKeyObj)
193                    throws com.liferay.portal.kernel.exception.PortalException;
194    
195            /**
196            * Returns the portal preferences with the primary key.
197            *
198            * @param portalPreferencesId the primary key of the portal preferences
199            * @return the portal preferences
200            * @throws PortalException if a portal preferences with the primary key could not be found
201            */
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public com.liferay.portal.model.PortalPreferences getPortalPreferences(
204                    long portalPreferencesId)
205                    throws com.liferay.portal.kernel.exception.PortalException;
206    
207            /**
208            * Returns a range of all the portal preferenceses.
209            *
210            * <p>
211            * 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.PortalPreferencesModelImpl}. 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.
212            * </p>
213            *
214            * @param start the lower bound of the range of portal preferenceses
215            * @param end the upper bound of the range of portal preferenceses (not inclusive)
216            * @return the range of portal preferenceses
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public java.util.List<com.liferay.portal.model.PortalPreferences> getPortalPreferenceses(
220                    int start, int end);
221    
222            /**
223            * Returns the number of portal preferenceses.
224            *
225            * @return the number of portal preferenceses
226            */
227            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
228            public int getPortalPreferencesesCount();
229    
230            /**
231            * @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int)}
232            */
233            @java.lang.Deprecated
234            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
235            public javax.portlet.PortletPreferences getPreferences(long companyId,
236                    long ownerId, int ownerType);
237    
238            /**
239            * @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int,
240            String)}
241            */
242            @java.lang.Deprecated
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public javax.portlet.PortletPreferences getPreferences(long companyId,
245                    long ownerId, int ownerType, java.lang.String defaultPreferences);
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public javax.portlet.PortletPreferences getPreferences(long ownerId,
249                    int ownerType);
250    
251            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
252            public javax.portlet.PortletPreferences getPreferences(long ownerId,
253                    int ownerType, java.lang.String defaultPreferences);
254    
255            /**
256            * Sets the Spring bean ID for this bean.
257            *
258            * @param beanIdentifier the Spring bean ID for this bean
259            */
260            public void setBeanIdentifier(java.lang.String beanIdentifier);
261    
262            /**
263            * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
264            *
265            * @param portalPreferences the portal preferences
266            * @return the portal preferences that was updated
267            */
268            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
269            public com.liferay.portal.model.PortalPreferences updatePortalPreferences(
270                    com.liferay.portal.model.PortalPreferences portalPreferences);
271    
272            public com.liferay.portal.model.PortalPreferences updatePreferences(
273                    long ownerId, int ownerType,
274                    com.liferay.portlet.PortalPreferences portalPreferences);
275    
276            public com.liferay.portal.model.PortalPreferences updatePreferences(
277                    long ownerId, int ownerType, java.lang.String xml);
278    }