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.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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.expando.model.impl.ExpandoColumnModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
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            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            public static com.liferay.portlet.expando.model.ExpandoColumn addColumn(
256                    long tableId, java.lang.String name, int type)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException {
259                    return getService().addColumn(tableId, name, type);
260            }
261    
262            public static com.liferay.portlet.expando.model.ExpandoColumn addColumn(
263                    long tableId, java.lang.String name, int type,
264                    java.lang.Object defaultData)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService().addColumn(tableId, name, type, defaultData);
268            }
269    
270            public static void deleteColumn(
271                    com.liferay.portlet.expando.model.ExpandoColumn column)
272                    throws com.liferay.portal.kernel.exception.SystemException {
273                    getService().deleteColumn(column);
274            }
275    
276            public static void deleteColumn(long columnId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    getService().deleteColumn(columnId);
280            }
281    
282            public static void deleteColumn(long companyId, long classNameId,
283                    java.lang.String tableName, java.lang.String name)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    getService().deleteColumn(companyId, classNameId, tableName, name);
287            }
288    
289            public static void deleteColumn(long tableId, java.lang.String name)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    getService().deleteColumn(tableId, name);
292            }
293    
294            public static void deleteColumn(long companyId, java.lang.String className,
295                    java.lang.String tableName, java.lang.String name)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    getService().deleteColumn(companyId, className, tableName, name);
299            }
300    
301            public static void deleteColumns(long tableId)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    getService().deleteColumns(tableId);
304            }
305    
306            public static void deleteColumns(long companyId, long classNameId,
307                    java.lang.String tableName)
308                    throws com.liferay.portal.kernel.exception.PortalException,
309                            com.liferay.portal.kernel.exception.SystemException {
310                    getService().deleteColumns(companyId, classNameId, tableName);
311            }
312    
313            public static void deleteColumns(long companyId,
314                    java.lang.String className, java.lang.String tableName)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    getService().deleteColumns(companyId, className, tableName);
318            }
319    
320            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
321                    long columnId)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    return getService().getColumn(columnId);
325            }
326    
327            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
328                    long companyId, long classNameId, java.lang.String tableName,
329                    java.lang.String name)
330                    throws com.liferay.portal.kernel.exception.SystemException {
331                    return getService().getColumn(companyId, classNameId, tableName, name);
332            }
333    
334            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
335                    long tableId, java.lang.String name)
336                    throws com.liferay.portal.kernel.exception.SystemException {
337                    return getService().getColumn(tableId, name);
338            }
339    
340            public static com.liferay.portlet.expando.model.ExpandoColumn getColumn(
341                    long companyId, java.lang.String className, java.lang.String tableName,
342                    java.lang.String name)
343                    throws com.liferay.portal.kernel.exception.SystemException {
344                    return getService().getColumn(companyId, className, tableName, name);
345            }
346    
347            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
348                    long tableId)
349                    throws com.liferay.portal.kernel.exception.SystemException {
350                    return getService().getColumns(tableId);
351            }
352    
353            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
354                    long tableId, java.util.Collection<java.lang.String> names)
355                    throws com.liferay.portal.kernel.exception.SystemException {
356                    return getService().getColumns(tableId, names);
357            }
358    
359            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
360                    long companyId, long classNameId, java.lang.String tableName)
361                    throws com.liferay.portal.kernel.exception.SystemException {
362                    return getService().getColumns(companyId, classNameId, tableName);
363            }
364    
365            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
366                    long companyId, long classNameId, java.lang.String tableName,
367                    java.util.Collection<java.lang.String> names)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService().getColumns(companyId, classNameId, tableName, names);
370            }
371    
372            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
373                    long companyId, java.lang.String className, java.lang.String tableName)
374                    throws com.liferay.portal.kernel.exception.SystemException {
375                    return getService().getColumns(companyId, className, tableName);
376            }
377    
378            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
379                    long companyId, java.lang.String className, java.lang.String tableName,
380                    java.util.Collection<java.lang.String> columnNames)
381                    throws com.liferay.portal.kernel.exception.SystemException {
382                    return getService()
383                                       .getColumns(companyId, className, tableName, columnNames);
384            }
385    
386            public static int getColumnsCount(long tableId)
387                    throws com.liferay.portal.kernel.exception.SystemException {
388                    return getService().getColumnsCount(tableId);
389            }
390    
391            public static int getColumnsCount(long companyId, long classNameId,
392                    java.lang.String tableName)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService().getColumnsCount(companyId, classNameId, tableName);
395            }
396    
397            public static int getColumnsCount(long companyId,
398                    java.lang.String className, java.lang.String tableName)
399                    throws com.liferay.portal.kernel.exception.SystemException {
400                    return getService().getColumnsCount(companyId, className, tableName);
401            }
402    
403            public static com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
404                    long companyId, long classNameId, java.lang.String name)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    return getService().getDefaultTableColumn(companyId, classNameId, name);
407            }
408    
409            public static com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
410                    long companyId, java.lang.String className, java.lang.String name)
411                    throws com.liferay.portal.kernel.exception.SystemException {
412                    return getService().getDefaultTableColumn(companyId, className, name);
413            }
414    
415            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
416                    long companyId, long classNameId)
417                    throws com.liferay.portal.kernel.exception.SystemException {
418                    return getService().getDefaultTableColumns(companyId, classNameId);
419            }
420    
421            public static java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
422                    long companyId, java.lang.String className)
423                    throws com.liferay.portal.kernel.exception.SystemException {
424                    return getService().getDefaultTableColumns(companyId, className);
425            }
426    
427            public static int getDefaultTableColumnsCount(long companyId,
428                    long classNameId)
429                    throws com.liferay.portal.kernel.exception.SystemException {
430                    return getService().getDefaultTableColumnsCount(companyId, classNameId);
431            }
432    
433            public static int getDefaultTableColumnsCount(long companyId,
434                    java.lang.String className)
435                    throws com.liferay.portal.kernel.exception.SystemException {
436                    return getService().getDefaultTableColumnsCount(companyId, className);
437            }
438    
439            public static com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
440                    long columnId, java.lang.String name, int type)
441                    throws com.liferay.portal.kernel.exception.PortalException,
442                            com.liferay.portal.kernel.exception.SystemException {
443                    return getService().updateColumn(columnId, name, type);
444            }
445    
446            public static com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
447                    long columnId, java.lang.String name, int type,
448                    java.lang.Object defaultData)
449                    throws com.liferay.portal.kernel.exception.PortalException,
450                            com.liferay.portal.kernel.exception.SystemException {
451                    return getService().updateColumn(columnId, name, type, defaultData);
452            }
453    
454            public static com.liferay.portlet.expando.model.ExpandoColumn updateTypeSettings(
455                    long columnId, java.lang.String typeSettings)
456                    throws com.liferay.portal.kernel.exception.PortalException,
457                            com.liferay.portal.kernel.exception.SystemException {
458                    return getService().updateTypeSettings(columnId, typeSettings);
459            }
460    
461            public static ExpandoColumnLocalService getService() {
462                    if (_service == null) {
463                            _service = (ExpandoColumnLocalService)PortalBeanLocatorUtil.locate(ExpandoColumnLocalService.class.getName());
464    
465                            ReferenceRegistry.registerReference(ExpandoColumnLocalServiceUtil.class,
466                                    "_service");
467                    }
468    
469                    return _service;
470            }
471    
472            /**
473             * @deprecated
474             */
475            public void setService(ExpandoColumnLocalService service) {
476            }
477    
478            private static ExpandoColumnLocalService _service;
479    }