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