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.kernel.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.model.PersistedModel;
026    import com.liferay.portal.kernel.model.PortalPreferences;
027    import com.liferay.portal.kernel.search.Indexable;
028    import com.liferay.portal.kernel.search.IndexableType;
029    import com.liferay.portal.kernel.transaction.Isolation;
030    import com.liferay.portal.kernel.transaction.Propagation;
031    import com.liferay.portal.kernel.transaction.Transactional;
032    import com.liferay.portal.kernel.util.OrderByComparator;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    import javax.portlet.PortletPreferences;
039    
040    /**
041     * Provides the local service interface for PortalPreferences. Methods of this
042     * service will not have security checks based on the propagated JAAS
043     * credentials because this service can only be accessed from within the same
044     * VM.
045     *
046     * @author Brian Wing Shun Chan
047     * @see PortalPreferencesLocalServiceUtil
048     * @see com.liferay.portal.service.base.PortalPreferencesLocalServiceBaseImpl
049     * @see com.liferay.portal.service.impl.PortalPreferencesLocalServiceImpl
050     * @generated
051     */
052    @ProviderType
053    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
054            PortalException.class, SystemException.class})
055    public interface PortalPreferencesLocalService extends BaseLocalService,
056            PersistedModelLocalService {
057            /*
058             * NOTE FOR DEVELOPERS:
059             *
060             * 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.
061             */
062            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
063            public ActionableDynamicQuery getActionableDynamicQuery();
064    
065            public DynamicQuery dynamicQuery();
066    
067            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
068            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
069    
070            /**
071            * @throws PortalException
072            */
073            @Override
074            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
075                    throws PortalException;
076    
077            @Override
078            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
079            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
080                    throws PortalException;
081    
082            /**
083            * Adds the portal preferences to the database. Also notifies the appropriate model listeners.
084            *
085            * @param portalPreferences the portal preferences
086            * @return the portal preferences that was added
087            */
088            @Indexable(type = IndexableType.REINDEX)
089            public PortalPreferences addPortalPreferences(
090                    PortalPreferences portalPreferences);
091    
092            public PortalPreferences addPortalPreferences(long ownerId, int ownerType,
093                    java.lang.String defaultPreferences);
094    
095            /**
096            * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.
097            *
098            * @param portalPreferencesId the primary key for the new portal preferences
099            * @return the new portal preferences
100            */
101            public PortalPreferences createPortalPreferences(long portalPreferencesId);
102    
103            /**
104            * Deletes the portal preferences from the database. Also notifies the appropriate model listeners.
105            *
106            * @param portalPreferences the portal preferences
107            * @return the portal preferences that was removed
108            */
109            @Indexable(type = IndexableType.DELETE)
110            public PortalPreferences deletePortalPreferences(
111                    PortalPreferences portalPreferences);
112    
113            /**
114            * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.
115            *
116            * @param portalPreferencesId the primary key of the portal preferences
117            * @return the portal preferences that was removed
118            * @throws PortalException if a portal preferences with the primary key could not be found
119            */
120            @Indexable(type = IndexableType.DELETE)
121            public PortalPreferences deletePortalPreferences(long portalPreferencesId)
122                    throws PortalException;
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public PortalPreferences fetchPortalPreferences(long portalPreferencesId);
126    
127            /**
128            * Returns the portal preferences with the primary key.
129            *
130            * @param portalPreferencesId the primary key of the portal preferences
131            * @return the portal preferences
132            * @throws PortalException if a portal preferences with the primary key could not be found
133            */
134            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
135            public PortalPreferences getPortalPreferences(long portalPreferencesId)
136                    throws PortalException;
137    
138            /**
139            * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
140            *
141            * @param portalPreferences the portal preferences
142            * @return the portal preferences that was updated
143            */
144            @Indexable(type = IndexableType.REINDEX)
145            public PortalPreferences updatePortalPreferences(
146                    PortalPreferences portalPreferences);
147    
148            public PortalPreferences updatePreferences(long ownerId, int ownerType,
149                    com.liferay.portal.kernel.portlet.PortalPreferences portalPreferences);
150    
151            public PortalPreferences updatePreferences(long ownerId, int ownerType,
152                    java.lang.String xml);
153    
154            /**
155            * Returns the number of portal preferenceses.
156            *
157            * @return the number of portal preferenceses
158            */
159            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160            public int getPortalPreferencesesCount();
161    
162            /**
163            * Returns the OSGi service identifier.
164            *
165            * @return the OSGi service identifier
166            */
167            public java.lang.String getOSGiServiceIdentifier();
168    
169            /**
170            * Performs a dynamic query on the database and returns the matching rows.
171            *
172            * @param dynamicQuery the dynamic query
173            * @return the matching rows
174            */
175            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
176    
177            /**
178            * Performs a dynamic query on the database and returns a range of the matching rows.
179            *
180            * <p>
181            * 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.
182            * </p>
183            *
184            * @param dynamicQuery the dynamic query
185            * @param start the lower bound of the range of model instances
186            * @param end the upper bound of the range of model instances (not inclusive)
187            * @return the range of matching rows
188            */
189            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
190                    int end);
191    
192            /**
193            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
194            *
195            * <p>
196            * 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.
197            * </p>
198            *
199            * @param dynamicQuery the dynamic query
200            * @param start the lower bound of the range of model instances
201            * @param end the upper bound of the range of model instances (not inclusive)
202            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
203            * @return the ordered range of matching rows
204            */
205            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
206                    int end, OrderByComparator<T> orderByComparator);
207    
208            /**
209            * Returns a range of all the portal preferenceses.
210            *
211            * <p>
212            * 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.
213            * </p>
214            *
215            * @param start the lower bound of the range of portal preferenceses
216            * @param end the upper bound of the range of portal preferenceses (not inclusive)
217            * @return the range of portal preferenceses
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public List<PortalPreferences> getPortalPreferenceses(int start, int end);
221    
222            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
223            public PortletPreferences getPreferences(long ownerId, int ownerType);
224    
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public PortletPreferences getPreferences(long ownerId, int ownerType,
227                    java.lang.String defaultPreferences);
228    
229            /**
230            * Returns the number of rows matching the dynamic query.
231            *
232            * @param dynamicQuery the dynamic query
233            * @return the number of rows matching the dynamic query
234            */
235            public long dynamicQueryCount(DynamicQuery dynamicQuery);
236    
237            /**
238            * Returns the number of rows matching the dynamic query.
239            *
240            * @param dynamicQuery the dynamic query
241            * @param projection the projection to apply to the query
242            * @return the number of rows matching the dynamic query
243            */
244            public long dynamicQueryCount(DynamicQuery dynamicQuery,
245                    Projection projection);
246    }