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.
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.
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.
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            * Updates the expando table in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
239            *
240            * @param expandoTable the expando table
241            * @param merge whether to merge the expando table with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
242            * @return the expando table that was updated
243            * @throws SystemException if a system exception occurred
244            */
245            public static com.liferay.portlet.expando.model.ExpandoTable updateExpandoTable(
246                    com.liferay.portlet.expando.model.ExpandoTable expandoTable,
247                    boolean merge)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateExpandoTable(expandoTable, merge);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.expando.model.ExpandoTable addDefaultTable(
271                    long companyId, long classNameId)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    return getService().addDefaultTable(companyId, classNameId);
275            }
276    
277            public static com.liferay.portlet.expando.model.ExpandoTable addDefaultTable(
278                    long companyId, java.lang.String className)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    return getService().addDefaultTable(companyId, className);
282            }
283    
284            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
285                    long companyId, long classNameId, java.lang.String name)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    return getService().addTable(companyId, classNameId, name);
289            }
290    
291            /**
292            * @deprecated {@link #addTable(long, long, String)}
293            */
294            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
295                    long classNameId, java.lang.String name)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService().addTable(classNameId, name);
299            }
300    
301            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
302                    long companyId, java.lang.String className, java.lang.String name)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException {
305                    return getService().addTable(companyId, className, name);
306            }
307    
308            /**
309            * @deprecated {@link #addTable(long, String, String)}
310            */
311            public static com.liferay.portlet.expando.model.ExpandoTable addTable(
312                    java.lang.String className, java.lang.String name)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    return getService().addTable(className, name);
316            }
317    
318            public static void deleteTable(
319                    com.liferay.portlet.expando.model.ExpandoTable table)
320                    throws com.liferay.portal.kernel.exception.SystemException {
321                    getService().deleteTable(table);
322            }
323    
324            public static void deleteTable(long tableId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteTable(tableId);
328            }
329    
330            public static void deleteTable(long companyId, long classNameId,
331                    java.lang.String name)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    getService().deleteTable(companyId, classNameId, name);
335            }
336    
337            public static void deleteTable(long companyId, java.lang.String className,
338                    java.lang.String name)
339                    throws com.liferay.portal.kernel.exception.PortalException,
340                            com.liferay.portal.kernel.exception.SystemException {
341                    getService().deleteTable(companyId, className, name);
342            }
343    
344            public static void deleteTables(long companyId, long classNameId)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    getService().deleteTables(companyId, classNameId);
347            }
348    
349            public static void deleteTables(long companyId, java.lang.String className)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    getService().deleteTables(companyId, className);
352            }
353    
354            public static com.liferay.portlet.expando.model.ExpandoTable fetchDefaultTable(
355                    long companyId, long classNameId)
356                    throws com.liferay.portal.kernel.exception.SystemException {
357                    return getService().fetchDefaultTable(companyId, classNameId);
358            }
359    
360            public static com.liferay.portlet.expando.model.ExpandoTable fetchDefaultTable(
361                    long companyId, java.lang.String className)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().fetchDefaultTable(companyId, className);
364            }
365    
366            public static com.liferay.portlet.expando.model.ExpandoTable fetchTable(
367                    long companyId, long classNameId, java.lang.String name)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().fetchTable(companyId, classNameId, name);
370            }
371    
372            public static com.liferay.portlet.expando.model.ExpandoTable getDefaultTable(
373                    long companyId, long classNameId)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    return getService().getDefaultTable(companyId, classNameId);
377            }
378    
379            public static com.liferay.portlet.expando.model.ExpandoTable getDefaultTable(
380                    long companyId, java.lang.String className)
381                    throws com.liferay.portal.kernel.exception.PortalException,
382                            com.liferay.portal.kernel.exception.SystemException {
383                    return getService().getDefaultTable(companyId, className);
384            }
385    
386            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
387                    long tableId)
388                    throws com.liferay.portal.kernel.exception.PortalException,
389                            com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getTable(tableId);
391            }
392    
393            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
394                    long companyId, long classNameId, java.lang.String name)
395                    throws com.liferay.portal.kernel.exception.PortalException,
396                            com.liferay.portal.kernel.exception.SystemException {
397                    return getService().getTable(companyId, classNameId, name);
398            }
399    
400            /**
401            * @deprecated {@link #getTable(long, long, String)}
402            */
403            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
404                    long classNameId, java.lang.String name)
405                    throws com.liferay.portal.kernel.exception.PortalException,
406                            com.liferay.portal.kernel.exception.SystemException {
407                    return getService().getTable(classNameId, name);
408            }
409    
410            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
411                    long companyId, java.lang.String className, java.lang.String name)
412                    throws com.liferay.portal.kernel.exception.PortalException,
413                            com.liferay.portal.kernel.exception.SystemException {
414                    return getService().getTable(companyId, className, name);
415            }
416    
417            /**
418            * @deprecated {@link #getTable(long, String, String)}
419            */
420            public static com.liferay.portlet.expando.model.ExpandoTable getTable(
421                    java.lang.String className, java.lang.String name)
422                    throws com.liferay.portal.kernel.exception.PortalException,
423                            com.liferay.portal.kernel.exception.SystemException {
424                    return getService().getTable(className, name);
425            }
426    
427            public static java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getTables(
428                    long companyId, long classNameId)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService().getTables(companyId, classNameId);
431            }
432    
433            public static java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getTables(
434                    long companyId, java.lang.String className)
435                    throws com.liferay.portal.kernel.exception.SystemException {
436                    return getService().getTables(companyId, className);
437            }
438    
439            public static com.liferay.portlet.expando.model.ExpandoTable updateTable(
440                    long tableId, java.lang.String name)
441                    throws com.liferay.portal.kernel.exception.PortalException,
442                            com.liferay.portal.kernel.exception.SystemException {
443                    return getService().updateTable(tableId, name);
444            }
445    
446            public static ExpandoTableLocalService getService() {
447                    if (_service == null) {
448                            _service = (ExpandoTableLocalService)PortalBeanLocatorUtil.locate(ExpandoTableLocalService.class.getName());
449    
450                            ReferenceRegistry.registerReference(ExpandoTableLocalServiceUtil.class,
451                                    "_service");
452                    }
453    
454                    return _service;
455            }
456    
457            /**
458             * @deprecated
459             */
460            public void setService(ExpandoTableLocalService service) {
461            }
462    
463            private static ExpandoTableLocalService _service;
464    }