001    /**
002     * Copyright (c) 2000-2011 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 column local service. This utility wraps {@link com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl} 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 ExpandoColumnLocalService
030     * @see com.liferay.portlet.expando.service.base.ExpandoColumnLocalServiceBaseImpl
031     * @see com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl
032     * @generated
033     */
034    public class ExpandoColumnLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the expando column to the database. Also notifies the appropriate model listeners.
043            *
044            * @param expandoColumn the expando column
045            * @return the expando column that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.expando.model.ExpandoColumn addExpandoColumn(
049                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addExpandoColumn(expandoColumn);
052            }
053    
054            /**
055            * Creates a new expando column with the primary key. Does not add the expando column to the database.
056            *
057            * @param columnId the primary key for the new expando column
058            * @return the new expando column
059            */
060            public static com.liferay.portlet.expando.model.ExpandoColumn createExpandoColumn(
061                    long columnId) {
062                    return getService().createExpandoColumn(columnId);
063            }
064    
065            /**
066            * Deletes the expando column with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param columnId the primary key of the expando column
069            * @throws PortalException if a expando column with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteExpandoColumn(long columnId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteExpandoColumn(columnId);
076            }
077    
078            /**
079            * Deletes the expando column from the database. Also notifies the appropriate model listeners.
080            *
081            * @param expandoColumn the expando column
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteExpandoColumn(
085                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteExpandoColumn(expandoColumn);
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            /**
162            * Returns the expando column with the primary key.
163            *
164            * @param columnId the primary key of the expando column
165            * @return the expando column
166            * @throws PortalException if a expando column with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.expando.model.ExpandoColumn getExpandoColumn(
170                    long columnId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getExpandoColumn(columnId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the expando columns.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of expando columns
191            * @param end the upper bound of the range of expando columns (not inclusive)
192            * @return the range of expando columns
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getExpandoColumns(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getExpandoColumns(start, end);
199            }
200    
201            /**
202            * Returns the number of expando columns.
203            *
204            * @return the number of expando columns
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getExpandoColumnsCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getExpandoColumnsCount();
210            }
211    
212            /**
213            * Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param expandoColumn the expando column
216            * @return the expando column that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.expando.model.ExpandoColumn updateExpandoColumn(
220                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateExpandoColumn(expandoColumn);
223            }
224    
225            /**
226            * Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param expandoColumn the expando column
229            * @param merge whether to merge the expando column 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.
230            * @return the expando column that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.expando.model.ExpandoColumn updateExpandoColumn(
234                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateExpandoColumn(expandoColumn, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portlet.expando.model.ExpandoColumn addColumn(
259                    long tableId, java.lang.String name, int type)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    return getService().addColumn(tableId, name, type);
263            }
264    
265            public static com.liferay.portlet.expando.model.ExpandoColumn addColumn(
266                    long tableId, java.lang.String name, int type,
267                    java.lang.Object defaultData)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    return getService().addColumn(tableId, name, type, defaultData);
271            }
272    
273            public static void deleteColumn(
274                    com.liferay.portlet.expando.model.ExpandoColumn column)
275                    throws com.liferay.portal.kernel.exception.SystemException {
276                    getService().deleteColumn(column);
277            }
278    
279            public static void deleteColumn(long columnId)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService().deleteColumn(columnId);
283            }
284    
285            public static void deleteColumn(long companyId, long classNameId,
286                    java.lang.String tableName, java.lang.String name)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService().deleteColumn(companyId, classNameId, tableName, name);
290            }
291    
292            public static void deleteColumn(long tableId, java.lang.String name)
293                    throws com.liferay.portal.kernel.exception.SystemException {
294                    getService().deleteColumn(tableId, name);
295            }
296    
297            public static void deleteColumn(long companyId, java.lang.String className,
298                    java.lang.String tableName, java.lang.String name)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService().deleteColumn(companyId, className, tableName, name);
302            }
303    
304            public static void deleteColumns(long tableId)
305                    throws com.liferay.portal.kernel.exception.SystemException {
306                    getService().deleteColumns(tableId);
307            }
308    
309            public static void deleteColumns(long companyId, long classNameId,
310                    java.lang.String tableName)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    getService().deleteColumns(companyId, classNameId, tableName);
314            }
315    
316            public static void deleteColumns(long companyId,
317                    java.lang.String className, java.lang.String tableName)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    getService().deleteColumns(companyId, className, tableName);
321            }
322    
323            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
324                    long columnId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService().getColumn(columnId);
328            }
329    
330            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
331                    long companyId, long classNameId, java.lang.String tableName,
332                    java.lang.String name)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getColumn(companyId, classNameId, tableName, name);
335            }
336    
337            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
338                    long tableId, java.lang.String name)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getColumn(tableId, name);
341            }
342    
343            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
344                    long companyId, java.lang.String className, java.lang.String tableName,
345                    java.lang.String name)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    return getService().getColumn(companyId, className, tableName, name);
348            }
349    
350            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
351                    long tableId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getColumns(tableId);
354            }
355    
356            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
357                    long tableId, java.util.Collection<java.lang.String> names)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getColumns(tableId, names);
360            }
361    
362            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
363                    long companyId, long classNameId, java.lang.String tableName)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getColumns(companyId, classNameId, tableName);
366            }
367    
368            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
369                    long companyId, long classNameId, java.lang.String tableName,
370                    java.util.Collection<java.lang.String> names)
371                    throws com.liferay.portal.kernel.exception.SystemException {
372                    return getService().getColumns(companyId, classNameId, tableName, names);
373            }
374    
375            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
376                    long companyId, java.lang.String className, java.lang.String tableName)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getColumns(companyId, className, tableName);
379            }
380    
381            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
382                    long companyId, java.lang.String className, java.lang.String tableName,
383                    java.util.Collection<java.lang.String> columnNames)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return getService()
386                                       .getColumns(companyId, className, tableName, columnNames);
387            }
388    
389            public static int getColumnsCount(long tableId)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService().getColumnsCount(tableId);
392            }
393    
394            public static int getColumnsCount(long companyId, long classNameId,
395                    java.lang.String tableName)
396                    throws com.liferay.portal.kernel.exception.SystemException {
397                    return getService().getColumnsCount(companyId, classNameId, tableName);
398            }
399    
400            public static int getColumnsCount(long companyId,
401                    java.lang.String className, java.lang.String tableName)
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService().getColumnsCount(companyId, className, tableName);
404            }
405    
406            public static com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
407                    long companyId, long classNameId, java.lang.String name)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService().getDefaultTableColumn(companyId, classNameId, name);
410            }
411    
412            public static com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
413                    long companyId, java.lang.String className, java.lang.String name)
414                    throws com.liferay.portal.kernel.exception.SystemException {
415                    return getService().getDefaultTableColumn(companyId, className, name);
416            }
417    
418            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
419                    long companyId, long classNameId)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getDefaultTableColumns(companyId, classNameId);
422            }
423    
424            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
425                    long companyId, java.lang.String className)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getDefaultTableColumns(companyId, className);
428            }
429    
430            public static int getDefaultTableColumnsCount(long companyId,
431                    long classNameId)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService().getDefaultTableColumnsCount(companyId, classNameId);
434            }
435    
436            public static int getDefaultTableColumnsCount(long companyId,
437                    java.lang.String className)
438                    throws com.liferay.portal.kernel.exception.SystemException {
439                    return getService().getDefaultTableColumnsCount(companyId, className);
440            }
441    
442            public static com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
443                    long columnId, java.lang.String name, int type)
444                    throws com.liferay.portal.kernel.exception.PortalException,
445                            com.liferay.portal.kernel.exception.SystemException {
446                    return getService().updateColumn(columnId, name, type);
447            }
448    
449            public static com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
450                    long columnId, java.lang.String name, int type,
451                    java.lang.Object defaultData)
452                    throws com.liferay.portal.kernel.exception.PortalException,
453                            com.liferay.portal.kernel.exception.SystemException {
454                    return getService().updateColumn(columnId, name, type, defaultData);
455            }
456    
457            public static com.liferay.portlet.expando.model.ExpandoColumn updateTypeSettings(
458                    long columnId, java.lang.String typeSettings)
459                    throws com.liferay.portal.kernel.exception.PortalException,
460                            com.liferay.portal.kernel.exception.SystemException {
461                    return getService().updateTypeSettings(columnId, typeSettings);
462            }
463    
464            public static ExpandoColumnLocalService getService() {
465                    if (_service == null) {
466                            _service = (ExpandoColumnLocalService)PortalBeanLocatorUtil.locate(ExpandoColumnLocalService.class.getName());
467    
468                            ReferenceRegistry.registerReference(ExpandoColumnLocalServiceUtil.class,
469                                    "_service");
470                            MethodCache.remove(ExpandoColumnLocalService.class);
471                    }
472    
473                    return _service;
474            }
475    
476            public void setService(ExpandoColumnLocalService service) {
477                    MethodCache.remove(ExpandoColumnLocalService.class);
478    
479                    _service = service;
480    
481                    ReferenceRegistry.registerReference(ExpandoColumnLocalServiceUtil.class,
482                            "_service");
483                    MethodCache.remove(ExpandoColumnLocalService.class);
484            }
485    
486            private static ExpandoColumnLocalService _service;
487    }