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 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            public static com.liferay.portlet.expando.model.ExpandoColumn fetchExpandoColumn(
162                    long columnId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchExpandoColumn(columnId);
165            }
166    
167            /**
168            * Returns the expando column with the primary key.
169            *
170            * @param columnId the primary key of the expando column
171            * @return the expando column
172            * @throws PortalException if a expando column 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.ExpandoColumn getExpandoColumn(
176                    long columnId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getExpandoColumn(columnId);
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 columns.
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 columns
197            * @param end the upper bound of the range of expando columns (not inclusive)
198            * @return the range of expando columns
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getExpandoColumns(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getExpandoColumns(start, end);
205            }
206    
207            /**
208            * Returns the number of expando columns.
209            *
210            * @return the number of expando columns
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getExpandoColumnsCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getExpandoColumnsCount();
216            }
217    
218            /**
219            * Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param expandoColumn the expando column
222            * @return the expando column that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portlet.expando.model.ExpandoColumn updateExpandoColumn(
226                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateExpandoColumn(expandoColumn);
229            }
230    
231            /**
232            * Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param expandoColumn the expando column
235            * @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.
236            * @return the expando column that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portlet.expando.model.ExpandoColumn updateExpandoColumn(
240                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService().updateExpandoColumn(expandoColumn, 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.ExpandoColumn addColumn(
265                    long tableId, java.lang.String name, int type)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException {
268                    return getService().addColumn(tableId, name, type);
269            }
270    
271            public static com.liferay.portlet.expando.model.ExpandoColumn addColumn(
272                    long tableId, java.lang.String name, int type,
273                    java.lang.Object defaultData)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    return getService().addColumn(tableId, name, type, defaultData);
277            }
278    
279            public static void deleteColumn(
280                    com.liferay.portlet.expando.model.ExpandoColumn column)
281                    throws com.liferay.portal.kernel.exception.SystemException {
282                    getService().deleteColumn(column);
283            }
284    
285            public static void deleteColumn(long columnId)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    getService().deleteColumn(columnId);
289            }
290    
291            public static void deleteColumn(long companyId, long classNameId,
292                    java.lang.String tableName, java.lang.String name)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService().deleteColumn(companyId, classNameId, tableName, name);
296            }
297    
298            public static void deleteColumn(long tableId, java.lang.String name)
299                    throws com.liferay.portal.kernel.exception.SystemException {
300                    getService().deleteColumn(tableId, name);
301            }
302    
303            public static void deleteColumn(long companyId, java.lang.String className,
304                    java.lang.String tableName, java.lang.String name)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    getService().deleteColumn(companyId, className, tableName, name);
308            }
309    
310            public static void deleteColumns(long tableId)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    getService().deleteColumns(tableId);
313            }
314    
315            public static void deleteColumns(long companyId, long classNameId,
316                    java.lang.String tableName)
317                    throws com.liferay.portal.kernel.exception.PortalException,
318                            com.liferay.portal.kernel.exception.SystemException {
319                    getService().deleteColumns(companyId, classNameId, tableName);
320            }
321    
322            public static void deleteColumns(long companyId,
323                    java.lang.String className, java.lang.String tableName)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    getService().deleteColumns(companyId, className, tableName);
327            }
328    
329            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
330                    long columnId)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException {
333                    return getService().getColumn(columnId);
334            }
335    
336            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
337                    long companyId, long classNameId, java.lang.String tableName,
338                    java.lang.String name)
339                    throws com.liferay.portal.kernel.exception.SystemException {
340                    return getService().getColumn(companyId, classNameId, tableName, name);
341            }
342    
343            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
344                    long tableId, java.lang.String name)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService().getColumn(tableId, name);
347            }
348    
349            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
350                    long companyId, java.lang.String className, java.lang.String tableName,
351                    java.lang.String name)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getColumn(companyId, className, tableName, name);
354            }
355    
356            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
357                    long tableId)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getColumns(tableId);
360            }
361    
362            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
363                    long tableId, java.util.Collection<java.lang.String> names)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return getService().getColumns(tableId, names);
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                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService().getColumns(companyId, classNameId, tableName);
372            }
373    
374            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
375                    long companyId, long classNameId, java.lang.String tableName,
376                    java.util.Collection<java.lang.String> names)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getColumns(companyId, classNameId, tableName, names);
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                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getColumns(companyId, className, tableName);
385            }
386    
387            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
388                    long companyId, java.lang.String className, java.lang.String tableName,
389                    java.util.Collection<java.lang.String> columnNames)
390                    throws com.liferay.portal.kernel.exception.SystemException {
391                    return getService()
392                                       .getColumns(companyId, className, tableName, columnNames);
393            }
394    
395            public static int getColumnsCount(long tableId)
396                    throws com.liferay.portal.kernel.exception.SystemException {
397                    return getService().getColumnsCount(tableId);
398            }
399    
400            public static int getColumnsCount(long companyId, long classNameId,
401                    java.lang.String tableName)
402                    throws com.liferay.portal.kernel.exception.SystemException {
403                    return getService().getColumnsCount(companyId, classNameId, tableName);
404            }
405    
406            public static int getColumnsCount(long companyId,
407                    java.lang.String className, java.lang.String tableName)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService().getColumnsCount(companyId, className, tableName);
410            }
411    
412            public static com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
413                    long companyId, long classNameId, java.lang.String name)
414                    throws com.liferay.portal.kernel.exception.SystemException {
415                    return getService().getDefaultTableColumn(companyId, classNameId, name);
416            }
417    
418            public static com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
419                    long companyId, java.lang.String className, java.lang.String name)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return getService().getDefaultTableColumn(companyId, className, name);
422            }
423    
424            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
425                    long companyId, long classNameId)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().getDefaultTableColumns(companyId, classNameId);
428            }
429    
430            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
431                    long companyId, java.lang.String className)
432                    throws com.liferay.portal.kernel.exception.SystemException {
433                    return getService().getDefaultTableColumns(companyId, className);
434            }
435    
436            public static int getDefaultTableColumnsCount(long companyId,
437                    long classNameId)
438                    throws com.liferay.portal.kernel.exception.SystemException {
439                    return getService().getDefaultTableColumnsCount(companyId, classNameId);
440            }
441    
442            public static int getDefaultTableColumnsCount(long companyId,
443                    java.lang.String className)
444                    throws com.liferay.portal.kernel.exception.SystemException {
445                    return getService().getDefaultTableColumnsCount(companyId, className);
446            }
447    
448            public static com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
449                    long columnId, java.lang.String name, int type)
450                    throws com.liferay.portal.kernel.exception.PortalException,
451                            com.liferay.portal.kernel.exception.SystemException {
452                    return getService().updateColumn(columnId, name, type);
453            }
454    
455            public static com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
456                    long columnId, java.lang.String name, int type,
457                    java.lang.Object defaultData)
458                    throws com.liferay.portal.kernel.exception.PortalException,
459                            com.liferay.portal.kernel.exception.SystemException {
460                    return getService().updateColumn(columnId, name, type, defaultData);
461            }
462    
463            public static com.liferay.portlet.expando.model.ExpandoColumn updateTypeSettings(
464                    long columnId, java.lang.String typeSettings)
465                    throws com.liferay.portal.kernel.exception.PortalException,
466                            com.liferay.portal.kernel.exception.SystemException {
467                    return getService().updateTypeSettings(columnId, typeSettings);
468            }
469    
470            public static ExpandoColumnLocalService getService() {
471                    if (_service == null) {
472                            _service = (ExpandoColumnLocalService)PortalBeanLocatorUtil.locate(ExpandoColumnLocalService.class.getName());
473    
474                            ReferenceRegistry.registerReference(ExpandoColumnLocalServiceUtil.class,
475                                    "_service");
476                            MethodCache.remove(ExpandoColumnLocalService.class);
477                    }
478    
479                    return _service;
480            }
481    
482            public void setService(ExpandoColumnLocalService service) {
483                    MethodCache.remove(ExpandoColumnLocalService.class);
484    
485                    _service = service;
486    
487                    ReferenceRegistry.registerReference(ExpandoColumnLocalServiceUtil.class,
488                            "_service");
489                    MethodCache.remove(ExpandoColumnLocalService.class);
490            }
491    
492            private static ExpandoColumnLocalService _service;
493    }