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.base;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.BeanReference;
020    import com.liferay.portal.kernel.dao.db.DB;
021    import com.liferay.portal.kernel.dao.db.DBFactoryUtil;
022    import com.liferay.portal.kernel.dao.jdbc.SqlUpdate;
023    import com.liferay.portal.kernel.dao.jdbc.SqlUpdateFactoryUtil;
024    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
025    import com.liferay.portal.kernel.dao.orm.DefaultActionableDynamicQuery;
026    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
027    import com.liferay.portal.kernel.dao.orm.DynamicQueryFactoryUtil;
028    import com.liferay.portal.kernel.dao.orm.Projection;
029    import com.liferay.portal.kernel.exception.PortalException;
030    import com.liferay.portal.kernel.exception.SystemException;
031    import com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService;
032    import com.liferay.portal.kernel.search.Indexable;
033    import com.liferay.portal.kernel.search.IndexableType;
034    import com.liferay.portal.kernel.util.OrderByComparator;
035    import com.liferay.portal.model.PersistedModel;
036    import com.liferay.portal.model.ServiceComponent;
037    import com.liferay.portal.service.BaseLocalServiceImpl;
038    import com.liferay.portal.service.PersistedModelLocalServiceRegistry;
039    import com.liferay.portal.service.ServiceComponentLocalService;
040    import com.liferay.portal.service.persistence.ServiceComponentFinder;
041    import com.liferay.portal.service.persistence.ServiceComponentPersistence;
042    import com.liferay.portal.util.PortalUtil;
043    
044    import java.io.Serializable;
045    
046    import java.util.List;
047    
048    import javax.sql.DataSource;
049    
050    /**
051     * Provides the base implementation for the service component local service.
052     *
053     * <p>
054     * This implementation exists only as a container for the default service methods generated by ServiceBuilder. All custom service methods should be put in {@link com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl}.
055     * </p>
056     *
057     * @author Brian Wing Shun Chan
058     * @see com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl
059     * @see com.liferay.portal.service.ServiceComponentLocalServiceUtil
060     * @generated
061     */
062    @ProviderType
063    public abstract class ServiceComponentLocalServiceBaseImpl
064            extends BaseLocalServiceImpl implements ServiceComponentLocalService,
065                    IdentifiableOSGiService {
066            /*
067             * NOTE FOR DEVELOPERS:
068             *
069             * Never modify or reference this class directly. Always use {@link com.liferay.portal.service.ServiceComponentLocalServiceUtil} to access the service component local service.
070             */
071    
072            /**
073             * Adds the service component to the database. Also notifies the appropriate model listeners.
074             *
075             * @param serviceComponent the service component
076             * @return the service component that was added
077             */
078            @Indexable(type = IndexableType.REINDEX)
079            @Override
080            public ServiceComponent addServiceComponent(
081                    ServiceComponent serviceComponent) {
082                    serviceComponent.setNew(true);
083    
084                    return serviceComponentPersistence.update(serviceComponent);
085            }
086    
087            /**
088             * Creates a new service component with the primary key. Does not add the service component to the database.
089             *
090             * @param serviceComponentId the primary key for the new service component
091             * @return the new service component
092             */
093            @Override
094            public ServiceComponent createServiceComponent(long serviceComponentId) {
095                    return serviceComponentPersistence.create(serviceComponentId);
096            }
097    
098            /**
099             * Deletes the service component with the primary key from the database. Also notifies the appropriate model listeners.
100             *
101             * @param serviceComponentId the primary key of the service component
102             * @return the service component that was removed
103             * @throws PortalException if a service component with the primary key could not be found
104             */
105            @Indexable(type = IndexableType.DELETE)
106            @Override
107            public ServiceComponent deleteServiceComponent(long serviceComponentId)
108                    throws PortalException {
109                    return serviceComponentPersistence.remove(serviceComponentId);
110            }
111    
112            /**
113             * Deletes the service component from the database. Also notifies the appropriate model listeners.
114             *
115             * @param serviceComponent the service component
116             * @return the service component that was removed
117             */
118            @Indexable(type = IndexableType.DELETE)
119            @Override
120            public ServiceComponent deleteServiceComponent(
121                    ServiceComponent serviceComponent) {
122                    return serviceComponentPersistence.remove(serviceComponent);
123            }
124    
125            @Override
126            public DynamicQuery dynamicQuery() {
127                    Class<?> clazz = getClass();
128    
129                    return DynamicQueryFactoryUtil.forClass(ServiceComponent.class,
130                            clazz.getClassLoader());
131            }
132    
133            /**
134             * Performs a dynamic query on the database and returns the matching rows.
135             *
136             * @param dynamicQuery the dynamic query
137             * @return the matching rows
138             */
139            @Override
140            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) {
141                    return serviceComponentPersistence.findWithDynamicQuery(dynamicQuery);
142            }
143    
144            /**
145             * Performs a dynamic query on the database and returns a range of the matching rows.
146             *
147             * <p>
148             * 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.
149             * </p>
150             *
151             * @param dynamicQuery the dynamic query
152             * @param start the lower bound of the range of model instances
153             * @param end the upper bound of the range of model instances (not inclusive)
154             * @return the range of matching rows
155             */
156            @Override
157            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
158                    int end) {
159                    return serviceComponentPersistence.findWithDynamicQuery(dynamicQuery,
160                            start, end);
161            }
162    
163            /**
164             * Performs a dynamic query on the database and returns an ordered range of the matching rows.
165             *
166             * <p>
167             * 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.
168             * </p>
169             *
170             * @param dynamicQuery the dynamic query
171             * @param start the lower bound of the range of model instances
172             * @param end the upper bound of the range of model instances (not inclusive)
173             * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
174             * @return the ordered range of matching rows
175             */
176            @Override
177            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
178                    int end, OrderByComparator<T> orderByComparator) {
179                    return serviceComponentPersistence.findWithDynamicQuery(dynamicQuery,
180                            start, end, orderByComparator);
181            }
182    
183            /**
184             * Returns the number of rows matching the dynamic query.
185             *
186             * @param dynamicQuery the dynamic query
187             * @return the number of rows matching the dynamic query
188             */
189            @Override
190            public long dynamicQueryCount(DynamicQuery dynamicQuery) {
191                    return serviceComponentPersistence.countWithDynamicQuery(dynamicQuery);
192            }
193    
194            /**
195             * Returns the number of rows matching the dynamic query.
196             *
197             * @param dynamicQuery the dynamic query
198             * @param projection the projection to apply to the query
199             * @return the number of rows matching the dynamic query
200             */
201            @Override
202            public long dynamicQueryCount(DynamicQuery dynamicQuery,
203                    Projection projection) {
204                    return serviceComponentPersistence.countWithDynamicQuery(dynamicQuery,
205                            projection);
206            }
207    
208            @Override
209            public ServiceComponent fetchServiceComponent(long serviceComponentId) {
210                    return serviceComponentPersistence.fetchByPrimaryKey(serviceComponentId);
211            }
212    
213            /**
214             * Returns the service component with the primary key.
215             *
216             * @param serviceComponentId the primary key of the service component
217             * @return the service component
218             * @throws PortalException if a service component with the primary key could not be found
219             */
220            @Override
221            public ServiceComponent getServiceComponent(long serviceComponentId)
222                    throws PortalException {
223                    return serviceComponentPersistence.findByPrimaryKey(serviceComponentId);
224            }
225    
226            @Override
227            public ActionableDynamicQuery getActionableDynamicQuery() {
228                    ActionableDynamicQuery actionableDynamicQuery = new DefaultActionableDynamicQuery();
229    
230                    actionableDynamicQuery.setBaseLocalService(com.liferay.portal.service.ServiceComponentLocalServiceUtil.getService());
231                    actionableDynamicQuery.setClass(ServiceComponent.class);
232                    actionableDynamicQuery.setClassLoader(getClassLoader());
233    
234                    actionableDynamicQuery.setPrimaryKeyPropertyName("serviceComponentId");
235    
236                    return actionableDynamicQuery;
237            }
238    
239            protected void initActionableDynamicQuery(
240                    ActionableDynamicQuery actionableDynamicQuery) {
241                    actionableDynamicQuery.setBaseLocalService(com.liferay.portal.service.ServiceComponentLocalServiceUtil.getService());
242                    actionableDynamicQuery.setClass(ServiceComponent.class);
243                    actionableDynamicQuery.setClassLoader(getClassLoader());
244    
245                    actionableDynamicQuery.setPrimaryKeyPropertyName("serviceComponentId");
246            }
247    
248            /**
249             * @throws PortalException
250             */
251            @Override
252            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
253                    throws PortalException {
254                    return serviceComponentLocalService.deleteServiceComponent((ServiceComponent)persistedModel);
255            }
256    
257            @Override
258            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
259                    throws PortalException {
260                    return serviceComponentPersistence.findByPrimaryKey(primaryKeyObj);
261            }
262    
263            /**
264             * Returns a range of all the service components.
265             *
266             * <p>
267             * 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.
268             * </p>
269             *
270             * @param start the lower bound of the range of service components
271             * @param end the upper bound of the range of service components (not inclusive)
272             * @return the range of service components
273             */
274            @Override
275            public List<ServiceComponent> getServiceComponents(int start, int end) {
276                    return serviceComponentPersistence.findAll(start, end);
277            }
278    
279            /**
280             * Returns the number of service components.
281             *
282             * @return the number of service components
283             */
284            @Override
285            public int getServiceComponentsCount() {
286                    return serviceComponentPersistence.countAll();
287            }
288    
289            /**
290             * Updates the service component in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
291             *
292             * @param serviceComponent the service component
293             * @return the service component that was updated
294             */
295            @Indexable(type = IndexableType.REINDEX)
296            @Override
297            public ServiceComponent updateServiceComponent(
298                    ServiceComponent serviceComponent) {
299                    return serviceComponentPersistence.update(serviceComponent);
300            }
301    
302            /**
303             * Returns the service component local service.
304             *
305             * @return the service component local service
306             */
307            public ServiceComponentLocalService getServiceComponentLocalService() {
308                    return serviceComponentLocalService;
309            }
310    
311            /**
312             * Sets the service component local service.
313             *
314             * @param serviceComponentLocalService the service component local service
315             */
316            public void setServiceComponentLocalService(
317                    ServiceComponentLocalService serviceComponentLocalService) {
318                    this.serviceComponentLocalService = serviceComponentLocalService;
319            }
320    
321            /**
322             * Returns the service component persistence.
323             *
324             * @return the service component persistence
325             */
326            public ServiceComponentPersistence getServiceComponentPersistence() {
327                    return serviceComponentPersistence;
328            }
329    
330            /**
331             * Sets the service component persistence.
332             *
333             * @param serviceComponentPersistence the service component persistence
334             */
335            public void setServiceComponentPersistence(
336                    ServiceComponentPersistence serviceComponentPersistence) {
337                    this.serviceComponentPersistence = serviceComponentPersistence;
338            }
339    
340            /**
341             * Returns the service component finder.
342             *
343             * @return the service component finder
344             */
345            public ServiceComponentFinder getServiceComponentFinder() {
346                    return serviceComponentFinder;
347            }
348    
349            /**
350             * Sets the service component finder.
351             *
352             * @param serviceComponentFinder the service component finder
353             */
354            public void setServiceComponentFinder(
355                    ServiceComponentFinder serviceComponentFinder) {
356                    this.serviceComponentFinder = serviceComponentFinder;
357            }
358    
359            /**
360             * Returns the counter local service.
361             *
362             * @return the counter local service
363             */
364            public com.liferay.counter.service.CounterLocalService getCounterLocalService() {
365                    return counterLocalService;
366            }
367    
368            /**
369             * Sets the counter local service.
370             *
371             * @param counterLocalService the counter local service
372             */
373            public void setCounterLocalService(
374                    com.liferay.counter.service.CounterLocalService counterLocalService) {
375                    this.counterLocalService = counterLocalService;
376            }
377    
378            public void afterPropertiesSet() {
379                    persistedModelLocalServiceRegistry.register("com.liferay.portal.model.ServiceComponent",
380                            serviceComponentLocalService);
381            }
382    
383            public void destroy() {
384                    persistedModelLocalServiceRegistry.unregister(
385                            "com.liferay.portal.model.ServiceComponent");
386            }
387    
388            /**
389             * Returns the OSGi service identifier.
390             *
391             * @return the OSGi service identifier
392             */
393            @Override
394            public String getOSGiServiceIdentifier() {
395                    return ServiceComponentLocalService.class.getName();
396            }
397    
398            protected Class<?> getModelClass() {
399                    return ServiceComponent.class;
400            }
401    
402            protected String getModelClassName() {
403                    return ServiceComponent.class.getName();
404            }
405    
406            /**
407             * Performs a SQL query.
408             *
409             * @param sql the sql query
410             */
411            protected void runSQL(String sql) {
412                    try {
413                            DataSource dataSource = serviceComponentPersistence.getDataSource();
414    
415                            DB db = DBFactoryUtil.getDB();
416    
417                            sql = db.buildSQL(sql);
418                            sql = PortalUtil.transformSQL(sql);
419    
420                            SqlUpdate sqlUpdate = SqlUpdateFactoryUtil.getSqlUpdate(dataSource,
421                                            sql, new int[0]);
422    
423                            sqlUpdate.update();
424                    }
425                    catch (Exception e) {
426                            throw new SystemException(e);
427                    }
428            }
429    
430            @BeanReference(type = com.liferay.portal.service.ServiceComponentLocalService.class)
431            protected ServiceComponentLocalService serviceComponentLocalService;
432            @BeanReference(type = ServiceComponentPersistence.class)
433            protected ServiceComponentPersistence serviceComponentPersistence;
434            @BeanReference(type = ServiceComponentFinder.class)
435            protected ServiceComponentFinder serviceComponentFinder;
436            @BeanReference(type = com.liferay.counter.service.CounterLocalService.class)
437            protected com.liferay.counter.service.CounterLocalService counterLocalService;
438            @BeanReference(type = PersistedModelLocalServiceRegistry.class)
439            protected PersistedModelLocalServiceRegistry persistedModelLocalServiceRegistry;
440    }