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.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.search.Indexable;
026    import com.liferay.portal.kernel.search.IndexableType;
027    import com.liferay.portal.kernel.transaction.Isolation;
028    import com.liferay.portal.kernel.transaction.Propagation;
029    import com.liferay.portal.kernel.transaction.Transactional;
030    import com.liferay.portal.kernel.util.OrderByComparator;
031    import com.liferay.portal.model.PersistedModel;
032    import com.liferay.portal.model.PluginSetting;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for PluginSetting. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see PluginSettingLocalServiceUtil
046     * @see com.liferay.portal.service.base.PluginSettingLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.PluginSettingLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface PluginSettingLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * Never modify or reference this interface directly. Always use {@link PluginSettingLocalServiceUtil} to access the plugin setting local service. Add custom service methods to {@link com.liferay.portal.service.impl.PluginSettingLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
059             */
060    
061            /**
062            * Adds the plugin setting to the database. Also notifies the appropriate model listeners.
063            *
064            * @param pluginSetting the plugin setting
065            * @return the plugin setting that was added
066            */
067            @Indexable(type = IndexableType.REINDEX)
068            public PluginSetting addPluginSetting(PluginSetting pluginSetting);
069    
070            public void checkPermission(long userId, java.lang.String pluginId,
071                    java.lang.String pluginType) throws PortalException;
072    
073            /**
074            * Creates a new plugin setting with the primary key. Does not add the plugin setting to the database.
075            *
076            * @param pluginSettingId the primary key for the new plugin setting
077            * @return the new plugin setting
078            */
079            public PluginSetting createPluginSetting(long pluginSettingId);
080    
081            /**
082            * @throws PortalException
083            */
084            @Override
085            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
086                    throws PortalException;
087    
088            /**
089            * Deletes the plugin setting from the database. Also notifies the appropriate model listeners.
090            *
091            * @param pluginSetting the plugin setting
092            * @return the plugin setting that was removed
093            */
094            @Indexable(type = IndexableType.DELETE)
095            public PluginSetting deletePluginSetting(PluginSetting pluginSetting);
096    
097            /**
098            * Deletes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.
099            *
100            * @param pluginSettingId the primary key of the plugin setting
101            * @return the plugin setting that was removed
102            * @throws PortalException if a plugin setting with the primary key could not be found
103            */
104            @Indexable(type = IndexableType.DELETE)
105            public PluginSetting deletePluginSetting(long pluginSettingId)
106                    throws PortalException;
107    
108            public DynamicQuery dynamicQuery();
109    
110            /**
111            * Performs a dynamic query on the database and returns the matching rows.
112            *
113            * @param dynamicQuery the dynamic query
114            * @return the matching rows
115            */
116            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
117    
118            /**
119            * Performs a dynamic query on the database and returns a range of the matching rows.
120            *
121            * <p>
122            * 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.PluginSettingModelImpl}. 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.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query
126            * @param start the lower bound of the range of model instances
127            * @param end the upper bound of the range of model instances (not inclusive)
128            * @return the range of matching rows
129            */
130            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
131                    int end);
132    
133            /**
134            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
135            *
136            * <p>
137            * 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.PluginSettingModelImpl}. 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.
138            * </p>
139            *
140            * @param dynamicQuery the dynamic query
141            * @param start the lower bound of the range of model instances
142            * @param end the upper bound of the range of model instances (not inclusive)
143            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
144            * @return the ordered range of matching rows
145            */
146            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
147                    int end, OrderByComparator<T> orderByComparator);
148    
149            /**
150            * Returns the number of rows matching the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows matching the dynamic query
154            */
155            public long dynamicQueryCount(DynamicQuery dynamicQuery);
156    
157            /**
158            * Returns the number of rows matching the dynamic query.
159            *
160            * @param dynamicQuery the dynamic query
161            * @param projection the projection to apply to the query
162            * @return the number of rows matching the dynamic query
163            */
164            public long dynamicQueryCount(DynamicQuery dynamicQuery,
165                    Projection projection);
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public PluginSetting fetchPluginSetting(long pluginSettingId);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public ActionableDynamicQuery getActionableDynamicQuery();
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public PluginSetting getDefaultPluginSetting();
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            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public PluginSetting getPluginSetting(long companyId,
193                    java.lang.String pluginId, java.lang.String pluginType);
194    
195            /**
196            * Returns the plugin setting with the primary key.
197            *
198            * @param pluginSettingId the primary key of the plugin setting
199            * @return the plugin setting
200            * @throws PortalException if a plugin setting with the primary key could not be found
201            */
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public PluginSetting getPluginSetting(long pluginSettingId)
204                    throws PortalException;
205    
206            /**
207            * Returns a range of all the plugin settings.
208            *
209            * <p>
210            * 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.PluginSettingModelImpl}. 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.
211            * </p>
212            *
213            * @param start the lower bound of the range of plugin settings
214            * @param end the upper bound of the range of plugin settings (not inclusive)
215            * @return the range of plugin settings
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public List<PluginSetting> getPluginSettings(int start, int end);
219    
220            /**
221            * Returns the number of plugin settings.
222            *
223            * @return the number of plugin settings
224            */
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public int getPluginSettingsCount();
227    
228            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
229            public boolean hasPermission(long userId, java.lang.String pluginId,
230                    java.lang.String pluginType);
231    
232            public PluginSetting updatePluginSetting(long companyId,
233                    java.lang.String pluginId, java.lang.String pluginType,
234                    java.lang.String roles, boolean active);
235    
236            /**
237            * Updates the plugin setting in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
238            *
239            * @param pluginSetting the plugin setting
240            * @return the plugin setting that was updated
241            */
242            @Indexable(type = IndexableType.REINDEX)
243            public PluginSetting updatePluginSetting(PluginSetting pluginSetting);
244    }