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            public PortalPreferences addPortalPreferences(long ownerId, int ownerType,
063                    java.lang.String defaultPreferences);
064    
065            /**
066            * Adds the portal preferences to the database. Also notifies the appropriate model listeners.
067            *
068            * @param portalPreferences the portal preferences
069            * @return the portal preferences that was added
070            */
071            @Indexable(type = IndexableType.REINDEX)
072            public PortalPreferences addPortalPreferences(
073                    PortalPreferences portalPreferences);
074    
075            /**
076            * Creates a new portal preferences with the primary key. Does not add the portal preferences to the database.
077            *
078            * @param portalPreferencesId the primary key for the new portal preferences
079            * @return the new portal preferences
080            */
081            public PortalPreferences createPortalPreferences(long portalPreferencesId);
082    
083            /**
084            * @throws PortalException
085            */
086            @Override
087            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
088                    throws PortalException;
089    
090            /**
091            * Deletes the portal preferences from the database. Also notifies the appropriate model listeners.
092            *
093            * @param portalPreferences the portal preferences
094            * @return the portal preferences that was removed
095            */
096            @Indexable(type = IndexableType.DELETE)
097            public PortalPreferences deletePortalPreferences(
098                    PortalPreferences portalPreferences);
099    
100            /**
101            * Deletes the portal preferences with the primary key from the database. Also notifies the appropriate model listeners.
102            *
103            * @param portalPreferencesId the primary key of the portal preferences
104            * @return the portal preferences that was removed
105            * @throws PortalException if a portal preferences with the primary key could not be found
106            */
107            @Indexable(type = IndexableType.DELETE)
108            public PortalPreferences deletePortalPreferences(long portalPreferencesId)
109                    throws PortalException;
110    
111            public DynamicQuery dynamicQuery();
112    
113            /**
114            * Performs a dynamic query on the database and returns the matching rows.
115            *
116            * @param dynamicQuery the dynamic query
117            * @return the matching rows
118            */
119            public <T> List<T> dynamicQuery(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> List<T> dynamicQuery(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> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
150                    int end, OrderByComparator<T> orderByComparator);
151    
152            /**
153            * Returns the number of rows matching the dynamic query.
154            *
155            * @param dynamicQuery the dynamic query
156            * @return the number of rows matching the dynamic query
157            */
158            public long dynamicQueryCount(DynamicQuery dynamicQuery);
159    
160            /**
161            * Returns the number of rows matching the dynamic query.
162            *
163            * @param dynamicQuery the dynamic query
164            * @param projection the projection to apply to the query
165            * @return the number of rows matching the dynamic query
166            */
167            public long dynamicQueryCount(DynamicQuery dynamicQuery,
168                    Projection projection);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public PortalPreferences fetchPortalPreferences(long portalPreferencesId);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public ActionableDynamicQuery getActionableDynamicQuery();
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
178    
179            /**
180            * Returns the OSGi service identifier.
181            *
182            * @return the OSGi service identifier
183            */
184            public java.lang.String getOSGiServiceIdentifier();
185    
186            @Override
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
189                    throws PortalException;
190    
191            /**
192            * Returns the portal preferences with the primary key.
193            *
194            * @param portalPreferencesId the primary key of the portal preferences
195            * @return the portal preferences
196            * @throws PortalException if a portal preferences with the primary key could not be found
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public PortalPreferences getPortalPreferences(long portalPreferencesId)
200                    throws PortalException;
201    
202            /**
203            * Returns a range of all the portal preferenceses.
204            *
205            * <p>
206            * 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.
207            * </p>
208            *
209            * @param start the lower bound of the range of portal preferenceses
210            * @param end the upper bound of the range of portal preferenceses (not inclusive)
211            * @return the range of portal preferenceses
212            */
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public List<PortalPreferences> getPortalPreferenceses(int start, int end);
215    
216            /**
217            * Returns the number of portal preferenceses.
218            *
219            * @return the number of portal preferenceses
220            */
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public int getPortalPreferencesesCount();
223    
224            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
225            public PortletPreferences getPreferences(long ownerId, int ownerType);
226    
227            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
228            public PortletPreferences getPreferences(long ownerId, int ownerType,
229                    java.lang.String defaultPreferences);
230    
231            /**
232            * Updates the portal preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param portalPreferences the portal preferences
235            * @return the portal preferences that was updated
236            */
237            @Indexable(type = IndexableType.REINDEX)
238            public PortalPreferences updatePortalPreferences(
239                    PortalPreferences portalPreferences);
240    
241            public PortalPreferences updatePreferences(long ownerId, int ownerType,
242                    com.liferay.portal.kernel.portlet.PortalPreferences portalPreferences);
243    
244            public PortalPreferences updatePreferences(long ownerId, int ownerType,
245                    java.lang.String xml);
246    }