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