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