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