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