001    /**
002     * Copyright (c) 2000-2013 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.portlet.expando.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for ExpandoTable. This utility wraps
024     * {@link com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see ExpandoTableLocalService
032     * @see com.liferay.portlet.expando.service.base.ExpandoTableLocalServiceBaseImpl
033     * @see com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class ExpandoTableLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
042             */
043    
044            /**
045            * Adds the expando table to the database. Also notifies the appropriate model listeners.
046            *
047            * @param expandoTable the expando table
048            * @return the expando table that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.expando.model.ExpandoTable addExpandoTable(
052                    com.liferay.portlet.expando.model.ExpandoTable expandoTable)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addExpandoTable(expandoTable);
055            }
056    
057            /**
058            * Creates a new expando table with the primary key. Does not add the expando table to the database.
059            *
060            * @param tableId the primary key for the new expando table
061            * @return the new expando table
062            */
063            public static com.liferay.portlet.expando.model.ExpandoTable createExpandoTable(
064                    long tableId) {
065                    return getService().createExpandoTable(tableId);
066            }
067    
068            /**
069            * Deletes the expando table with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param tableId the primary key of the expando table
072            * @return the expando table that was removed
073            * @throws PortalException if a expando table with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.expando.model.ExpandoTable deleteExpandoTable(
077                    long tableId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteExpandoTable(tableId);
081            }
082    
083            /**
084            * Deletes the expando table from the database. Also notifies the appropriate model listeners.
085            *
086            * @param expandoTable the expando table
087            * @return the expando table that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.expando.model.ExpandoTable deleteExpandoTable(
091                    com.liferay.portlet.expando.model.ExpandoTable expandoTable)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteExpandoTable(expandoTable);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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.portlet.expando.model.impl.ExpandoTableModelImpl}. 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.portlet.expando.model.impl.ExpandoTableModelImpl}. 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.expando.model.ExpandoTable fetchExpandoTable(
187                    long tableId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchExpandoTable(tableId);
190            }
191    
192            /**
193            * Returns the expando table with the primary key.
194            *
195            * @param tableId the primary key of the expando table
196            * @return the expando table
197            * @throws PortalException if a expando table with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.expando.model.ExpandoTable getExpandoTable(
201                    long tableId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getExpandoTable(tableId);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the expando tables.
216            *
217            * <p>
218            * 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.portlet.expando.model.impl.ExpandoTableModelImpl}. 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.
219            * </p>
220            *
221            * @param start the lower bound of the range of expando tables
222            * @param end the upper bound of the range of expando tables (not inclusive)
223            * @return the range of expando tables
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getExpandoTables(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getExpandoTables(start, end);
230            }
231    
232            /**
233            * Returns the number of expando tables.
234            *
235            * @return the number of expando tables
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getExpandoTablesCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getExpandoTablesCount();
241            }
242    
243            /**
244            * Updates the expando table in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param expandoTable the expando table
247            * @return the expando table that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.expando.model.ExpandoTable updateExpandoTable(
251                    com.liferay.portlet.expando.model.ExpandoTable expandoTable)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateExpandoTable(expandoTable);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static com.liferay.portlet.expando.model.ExpandoTable addDefaultTable(
275                    long companyId, long classNameId)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException {
278                    return getService().addDefaultTable(companyId, classNameId);
279            }
280    
281            public static com.liferay.portlet.expando.model.ExpandoTable addDefaultTable(
282                    long companyId, java.lang.String className)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException {
285                    return getService().addDefaultTable(companyId, className);
286            }
287    
288            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
289                    long companyId, long classNameId, java.lang.String name)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    return getService().addTable(companyId, classNameId, name);
293            }
294    
295            /**
296            * @deprecated As of 6.1.0, replaced by {@link #addTable(long, long,
297            String)}
298            */
299            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
300                    long classNameId, java.lang.String name)
301                    throws com.liferay.portal.kernel.exception.PortalException,
302                            com.liferay.portal.kernel.exception.SystemException {
303                    return getService().addTable(classNameId, name);
304            }
305    
306            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
307                    long companyId, java.lang.String className, java.lang.String name)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    return getService().addTable(companyId, className, name);
311            }
312    
313            /**
314            * @deprecated As of 6.1.0, replaced by {@link #addTable(long, String,
315            String)}
316            */
317            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
318                    java.lang.String className, java.lang.String name)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    return getService().addTable(className, name);
322            }
323    
324            public static void deleteTable(
325                    com.liferay.portlet.expando.model.ExpandoTable table)
326                    throws com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteTable(table);
328            }
329    
330            public static void deleteTable(long tableId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    getService().deleteTable(tableId);
334            }
335    
336            public static void deleteTable(long companyId, long classNameId,
337                    java.lang.String name)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    getService().deleteTable(companyId, classNameId, name);
341            }
342    
343            public static void deleteTable(long companyId, java.lang.String className,
344                    java.lang.String name)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    getService().deleteTable(companyId, className, name);
348            }
349    
350            public static void deleteTables(long companyId, long classNameId)
351                    throws com.liferay.portal.kernel.exception.SystemException {
352                    getService().deleteTables(companyId, classNameId);
353            }
354    
355            public static void deleteTables(long companyId, java.lang.String className)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    getService().deleteTables(companyId, className);
358            }
359    
360            public static com.liferay.portlet.expando.model.ExpandoTable fetchDefaultTable(
361                    long companyId, long classNameId)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().fetchDefaultTable(companyId, classNameId);
364            }
365    
366            public static com.liferay.portlet.expando.model.ExpandoTable fetchDefaultTable(
367                    long companyId, java.lang.String className)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().fetchDefaultTable(companyId, className);
370            }
371    
372            public static com.liferay.portlet.expando.model.ExpandoTable fetchTable(
373                    long companyId, long classNameId, java.lang.String name)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().fetchTable(companyId, classNameId, name);
376            }
377    
378            public static com.liferay.portlet.expando.model.ExpandoTable getDefaultTable(
379                    long companyId, long classNameId)
380                    throws com.liferay.portal.kernel.exception.PortalException,
381                            com.liferay.portal.kernel.exception.SystemException {
382                    return getService().getDefaultTable(companyId, classNameId);
383            }
384    
385            public static com.liferay.portlet.expando.model.ExpandoTable getDefaultTable(
386                    long companyId, java.lang.String className)
387                    throws com.liferay.portal.kernel.exception.PortalException,
388                            com.liferay.portal.kernel.exception.SystemException {
389                    return getService().getDefaultTable(companyId, className);
390            }
391    
392            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
393                    long tableId)
394                    throws com.liferay.portal.kernel.exception.PortalException,
395                            com.liferay.portal.kernel.exception.SystemException {
396                    return getService().getTable(tableId);
397            }
398    
399            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
400                    long companyId, long classNameId, java.lang.String name)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException {
403                    return getService().getTable(companyId, classNameId, name);
404            }
405    
406            /**
407            * @deprecated As of 6.1.0, replaced by {@link #getTable(long, long,
408            String)}
409            */
410            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
411                    long classNameId, java.lang.String name)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getTable(classNameId, name);
415            }
416    
417            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
418                    long companyId, java.lang.String className, java.lang.String name)
419                    throws com.liferay.portal.kernel.exception.PortalException,
420                            com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getTable(companyId, className, name);
422            }
423    
424            /**
425            * @deprecated As of 6.1.0, replaced by {@link #getTable(long, String,
426            String)}
427            */
428            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
429                    java.lang.String className, java.lang.String name)
430                    throws com.liferay.portal.kernel.exception.PortalException,
431                            com.liferay.portal.kernel.exception.SystemException {
432                    return getService().getTable(className, name);
433            }
434    
435            public static java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getTables(
436                    long companyId, long classNameId)
437                    throws com.liferay.portal.kernel.exception.SystemException {
438                    return getService().getTables(companyId, classNameId);
439            }
440    
441            public static java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getTables(
442                    long companyId, java.lang.String className)
443                    throws com.liferay.portal.kernel.exception.SystemException {
444                    return getService().getTables(companyId, className);
445            }
446    
447            public static com.liferay.portlet.expando.model.ExpandoTable updateTable(
448                    long tableId, java.lang.String name)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException {
451                    return getService().updateTable(tableId, name);
452            }
453    
454            public static ExpandoTableLocalService getService() {
455                    if (_service == null) {
456                            _service = (ExpandoTableLocalService)PortalBeanLocatorUtil.locate(ExpandoTableLocalService.class.getName());
457    
458                            ReferenceRegistry.registerReference(ExpandoTableLocalServiceUtil.class,
459                                    "_service");
460                    }
461    
462                    return _service;
463            }
464    
465            /**
466             * @deprecated As of 6.2.0
467             */
468            public void setService(ExpandoTableLocalService service) {
469            }
470    
471            private static ExpandoTableLocalService _service;
472    }