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 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) throws PortalException;
108    
109            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
110    
111            /**
112            * Performs a dynamic query on the database and returns the matching rows.
113            *
114            * @param dynamicQuery the dynamic query
115            * @return the matching rows
116            */
117            public <T> java.util.List<T> dynamicQuery(
118                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
119    
120            /**
121            * Performs a dynamic query on the database and returns a range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query
128            * @param start the lower bound of the range of model instances
129            * @param end the upper bound of the range of model instances (not inclusive)
130            * @return the range of matching rows
131            */
132            public <T> java.util.List<T> dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end);
135    
136            /**
137            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
138            *
139            * <p>
140            * 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.
141            * </p>
142            *
143            * @param dynamicQuery the dynamic query
144            * @param start the lower bound of the range of model instances
145            * @param end the upper bound of the range of model instances (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching rows
148            */
149            public <T> java.util.List<T> dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
153    
154            /**
155            * Returns the number of rows matching the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows matching the dynamic query
159            */
160            public long dynamicQueryCount(
161                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
162    
163            /**
164            * Returns the number of rows matching the dynamic query.
165            *
166            * @param dynamicQuery the dynamic query
167            * @param projection the projection to apply to the query
168            * @return the number of rows matching the dynamic query
169            */
170            public long dynamicQueryCount(
171                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
172                    com.liferay.portal.kernel.dao.orm.Projection projection);
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.PortalPreferences fetchPortalPreferences(
176                    long portalPreferencesId);
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
180    
181            /**
182            * Returns the Spring bean ID for this bean.
183            *
184            * @return the Spring bean ID for this bean
185            */
186            public java.lang.String getBeanIdentifier();
187    
188            @Override
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portal.model.PersistedModel getPersistedModel(
191                    java.io.Serializable primaryKeyObj) throws PortalException;
192    
193            /**
194            * Returns the portal preferences with the primary key.
195            *
196            * @param portalPreferencesId the primary key of the portal preferences
197            * @return the portal preferences
198            * @throws PortalException if a portal preferences with the primary key could not be found
199            */
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public com.liferay.portal.model.PortalPreferences getPortalPreferences(
202                    long portalPreferencesId) throws PortalException;
203    
204            /**
205            * Returns a range of all the portal preferenceses.
206            *
207            * <p>
208            * 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.
209            * </p>
210            *
211            * @param start the lower bound of the range of portal preferenceses
212            * @param end the upper bound of the range of portal preferenceses (not inclusive)
213            * @return the range of portal preferenceses
214            */
215            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216            public java.util.List<com.liferay.portal.model.PortalPreferences> getPortalPreferenceses(
217                    int start, int end);
218    
219            /**
220            * Returns the number of portal preferenceses.
221            *
222            * @return the number of portal preferenceses
223            */
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public int getPortalPreferencesesCount();
226    
227            /**
228            * @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int)}
229            */
230            @java.lang.Deprecated
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public javax.portlet.PortletPreferences getPreferences(long companyId,
233                    long ownerId, int ownerType);
234    
235            /**
236            * @deprecated As of 6.2.0, replaced by {@link #getPreferences(long, int,
237            String)}
238            */
239            @java.lang.Deprecated
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public javax.portlet.PortletPreferences getPreferences(long companyId,
242                    long ownerId, int ownerType, java.lang.String defaultPreferences);
243    
244            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245            public javax.portlet.PortletPreferences getPreferences(long ownerId,
246                    int ownerType);
247    
248            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249            public javax.portlet.PortletPreferences getPreferences(long ownerId,
250                    int ownerType, java.lang.String defaultPreferences);
251    
252            /**
253            * Sets the Spring bean ID for this bean.
254            *
255            * @param beanIdentifier the Spring bean ID for this bean
256            */
257            public void setBeanIdentifier(java.lang.String beanIdentifier);
258    
259            /**
260            * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
261            *
262            * @param portalPreferences the portal preferences
263            * @return the portal preferences that was updated
264            */
265            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
266            public com.liferay.portal.model.PortalPreferences updatePortalPreferences(
267                    com.liferay.portal.model.PortalPreferences portalPreferences);
268    
269            public com.liferay.portal.model.PortalPreferences updatePreferences(
270                    long ownerId, int ownerType,
271                    com.liferay.portlet.PortalPreferences portalPreferences);
272    
273            public com.liferay.portal.model.PortalPreferences updatePreferences(
274                    long ownerId, int ownerType, java.lang.String xml);
275    }