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 ServiceComponent. 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 ServiceComponentLocalServiceUtil
034     * @see com.liferay.portal.service.base.ServiceComponentLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface ServiceComponentLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link ServiceComponentLocalServiceUtil} to access the service component local service. Add custom service methods to {@link com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the service component to the database. Also notifies the appropriate model listeners.
051            *
052            * @param serviceComponent the service component
053            * @return the service component that was added
054            */
055            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
056            public com.liferay.portal.model.ServiceComponent addServiceComponent(
057                    com.liferay.portal.model.ServiceComponent serviceComponent);
058    
059            /**
060            * Creates a new service component with the primary key. Does not add the service component to the database.
061            *
062            * @param serviceComponentId the primary key for the new service component
063            * @return the new service component
064            */
065            public com.liferay.portal.model.ServiceComponent createServiceComponent(
066                    long serviceComponentId);
067    
068            /**
069            * @throws PortalException
070            */
071            @Override
072            public com.liferay.portal.model.PersistedModel deletePersistedModel(
073                    com.liferay.portal.model.PersistedModel persistedModel)
074                    throws com.liferay.portal.kernel.exception.PortalException;
075    
076            /**
077            * Deletes the service component from the database. Also notifies the appropriate model listeners.
078            *
079            * @param serviceComponent the service component
080            * @return the service component that was removed
081            */
082            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
083            public com.liferay.portal.model.ServiceComponent deleteServiceComponent(
084                    com.liferay.portal.model.ServiceComponent serviceComponent);
085    
086            /**
087            * Deletes the service component with the primary key from the database. Also notifies the appropriate model listeners.
088            *
089            * @param serviceComponentId the primary key of the service component
090            * @return the service component that was removed
091            * @throws PortalException if a service component with the primary key could not be found
092            */
093            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
094            public com.liferay.portal.model.ServiceComponent deleteServiceComponent(
095                    long serviceComponentId)
096                    throws com.liferay.portal.kernel.exception.PortalException;
097    
098            public void destroyServiceComponent(
099                    com.liferay.portal.service.configuration.ServiceComponentConfiguration serviceComponentConfiguration,
100                    java.lang.ClassLoader classLoader);
101    
102            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
103    
104            /**
105            * Performs a dynamic query on the database and returns the matching rows.
106            *
107            * @param dynamicQuery the dynamic query
108            * @return the matching rows
109            */
110            public <T> java.util.List<T> dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
112    
113            /**
114            * Performs a dynamic query on the database and returns a range of the matching rows.
115            *
116            * <p>
117            * 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.ServiceComponentModelImpl}. 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.
118            * </p>
119            *
120            * @param dynamicQuery the dynamic query
121            * @param start the lower bound of the range of model instances
122            * @param end the upper bound of the range of model instances (not inclusive)
123            * @return the range of matching rows
124            */
125            public <T> java.util.List<T> dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end);
128    
129            /**
130            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
131            *
132            * <p>
133            * 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.ServiceComponentModelImpl}. 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.
134            * </p>
135            *
136            * @param dynamicQuery the dynamic query
137            * @param start the lower bound of the range of model instances
138            * @param end the upper bound of the range of model instances (not inclusive)
139            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
140            * @return the ordered range of matching rows
141            */
142            public <T> java.util.List<T> dynamicQuery(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
144                    int end,
145                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
146    
147            /**
148            * Returns the number of rows matching the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows matching the dynamic query
152            */
153            public long dynamicQueryCount(
154                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
155    
156            /**
157            * Returns the number of rows matching the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @param projection the projection to apply to the query
161            * @return the number of rows matching the dynamic query
162            */
163            public long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
165                    com.liferay.portal.kernel.dao.orm.Projection projection);
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public com.liferay.portal.model.ServiceComponent fetchServiceComponent(
169                    long serviceComponentId);
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
173    
174            /**
175            * Returns the Spring bean ID for this bean.
176            *
177            * @return the Spring bean ID for this bean
178            */
179            public java.lang.String getBeanIdentifier();
180    
181            @Override
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public com.liferay.portal.model.PersistedModel getPersistedModel(
184                    java.io.Serializable primaryKeyObj)
185                    throws com.liferay.portal.kernel.exception.PortalException;
186    
187            /**
188            * Returns the service component with the primary key.
189            *
190            * @param serviceComponentId the primary key of the service component
191            * @return the service component
192            * @throws PortalException if a service component with the primary key could not be found
193            */
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portal.model.ServiceComponent getServiceComponent(
196                    long serviceComponentId)
197                    throws com.liferay.portal.kernel.exception.PortalException;
198    
199            /**
200            * Returns a range of all the service components.
201            *
202            * <p>
203            * 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.ServiceComponentModelImpl}. 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of service components
207            * @param end the upper bound of the range of service components (not inclusive)
208            * @return the range of service components
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public java.util.List<com.liferay.portal.model.ServiceComponent> getServiceComponents(
212                    int start, int end);
213    
214            /**
215            * Returns the number of service components.
216            *
217            * @return the number of service components
218            */
219            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
220            public int getServiceComponentsCount();
221    
222            public com.liferay.portal.model.ServiceComponent initServiceComponent(
223                    com.liferay.portal.service.configuration.ServiceComponentConfiguration serviceComponentConfiguration,
224                    java.lang.ClassLoader classLoader, java.lang.String buildNamespace,
225                    long buildNumber, long buildDate, boolean buildAutoUpgrade)
226                    throws com.liferay.portal.kernel.exception.PortalException;
227    
228            /**
229            * Sets the Spring bean ID for this bean.
230            *
231            * @param beanIdentifier the Spring bean ID for this bean
232            */
233            public void setBeanIdentifier(java.lang.String beanIdentifier);
234    
235            /**
236            * Updates the service component in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
237            *
238            * @param serviceComponent the service component
239            * @return the service component that was updated
240            */
241            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
242            public com.liferay.portal.model.ServiceComponent updateServiceComponent(
243                    com.liferay.portal.model.ServiceComponent serviceComponent);
244    
245            public void upgradeDB(java.lang.ClassLoader classLoader,
246                    java.lang.String buildNamespace, long buildNumber,
247                    boolean buildAutoUpgrade,
248                    com.liferay.portal.model.ServiceComponent previousServiceComponent,
249                    java.lang.String tablesSQL, java.lang.String sequencesSQL,
250                    java.lang.String indexesSQL) throws java.lang.Exception;
251    
252            public void verifyDB();
253    }