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