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