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