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 PluginSetting. 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 PluginSettingLocalServiceUtil
034     * @see com.liferay.portal.service.base.PluginSettingLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.PluginSettingLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface PluginSettingLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * 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.
047             */
048    
049            /**
050            * Adds the plugin setting to the database. Also notifies the appropriate model listeners.
051            *
052            * @param pluginSetting the plugin setting
053            * @return the plugin setting that was added
054            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.PluginSetting addPluginSetting(
057                    com.liferay.portal.model.PluginSetting pluginSetting);
058    
059            public void checkPermission(long userId, java.lang.String pluginId,
060                    java.lang.String pluginType) throws PortalException;
061    
062            /**
063            * Creates a new plugin setting with the primary key. Does not add the plugin setting to the database.
064            *
065            * @param pluginSettingId the primary key for the new plugin setting
066            * @return the new plugin setting
067            */
068            public com.liferay.portal.model.PluginSetting createPluginSetting(
069                    long pluginSettingId);
070    
071            /**
072            * @throws PortalException
073            */
074            @Override
075            public com.liferay.portal.model.PersistedModel deletePersistedModel(
076                    com.liferay.portal.model.PersistedModel persistedModel)
077                    throws PortalException;
078    
079            /**
080            * Deletes the plugin setting from the database. Also notifies the appropriate model listeners.
081            *
082            * @param pluginSetting the plugin setting
083            * @return the plugin setting that was removed
084            */
085            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
086            public com.liferay.portal.model.PluginSetting deletePluginSetting(
087                    com.liferay.portal.model.PluginSetting pluginSetting);
088    
089            /**
090            * Deletes the plugin setting with the primary key from the database. Also notifies the appropriate model listeners.
091            *
092            * @param pluginSettingId the primary key of the plugin setting
093            * @return the plugin setting that was removed
094            * @throws PortalException if a plugin setting with the primary key could not be found
095            */
096            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
097            public com.liferay.portal.model.PluginSetting deletePluginSetting(
098                    long pluginSettingId) throws PortalException;
099    
100            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
101    
102            /**
103            * Performs a dynamic query on the database and returns the matching rows.
104            *
105            * @param dynamicQuery the dynamic query
106            * @return the matching rows
107            */
108            public <T> java.util.List<T> dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            */
123            public <T> java.util.List<T> dynamicQuery(
124                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
125                    int end);
126    
127            /**
128            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
129            *
130            * <p>
131            * 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.
132            * </p>
133            *
134            * @param dynamicQuery the dynamic query
135            * @param start the lower bound of the range of model instances
136            * @param end the upper bound of the range of model instances (not inclusive)
137            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
138            * @return the ordered range of matching rows
139            */
140            public <T> java.util.List<T> dynamicQuery(
141                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
142                    int end,
143                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
144    
145            /**
146            * Returns the number of rows matching the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows matching the dynamic query
150            */
151            public long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
153    
154            /**
155            * Returns the number of rows matching the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @param projection the projection to apply to the 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                    com.liferay.portal.kernel.dao.orm.Projection projection);
164    
165            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
166            public com.liferay.portal.model.PluginSetting fetchPluginSetting(
167                    long pluginSettingId);
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
171    
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public com.liferay.portal.model.PluginSetting getDefaultPluginSetting();
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
177    
178            /**
179            * Returns the OSGi service identifier.
180            *
181            * @return the OSGi service identifier
182            */
183            public java.lang.String getOSGiServiceIdentifier();
184    
185            @Override
186            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
187            public com.liferay.portal.model.PersistedModel getPersistedModel(
188                    java.io.Serializable primaryKeyObj) throws PortalException;
189    
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.model.PluginSetting getPluginSetting(
192                    long companyId, java.lang.String pluginId, java.lang.String pluginType);
193    
194            /**
195            * Returns the plugin setting with the primary key.
196            *
197            * @param pluginSettingId the primary key of the plugin setting
198            * @return the plugin setting
199            * @throws PortalException if a plugin setting with the primary key could not be found
200            */
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public com.liferay.portal.model.PluginSetting getPluginSetting(
203                    long pluginSettingId) throws PortalException;
204    
205            /**
206            * Returns a range of all the plugin settings.
207            *
208            * <p>
209            * 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.
210            * </p>
211            *
212            * @param start the lower bound of the range of plugin settings
213            * @param end the upper bound of the range of plugin settings (not inclusive)
214            * @return the range of plugin settings
215            */
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public java.util.List<com.liferay.portal.model.PluginSetting> getPluginSettings(
218                    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 com.liferay.portal.model.PluginSetting updatePluginSetting(
233                    long companyId, 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            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
243            public com.liferay.portal.model.PluginSetting updatePluginSetting(
244                    com.liferay.portal.model.PluginSetting pluginSetting);
245    }