001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.expando.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the expando row local service. This utility wraps {@link com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl} 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 ExpandoRowLocalService
029     * @see com.liferay.portlet.expando.service.base.ExpandoRowLocalServiceBaseImpl
030     * @see com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl
031     * @generated
032     */
033    public class ExpandoRowLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the expando row to the database. Also notifies the appropriate model listeners.
042            *
043            * @param expandoRow the expando row
044            * @return the expando row that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.expando.model.ExpandoRow addExpandoRow(
048                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addExpandoRow(expandoRow);
051            }
052    
053            /**
054            * Creates a new expando row with the primary key. Does not add the expando row to the database.
055            *
056            * @param rowId the primary key for the new expando row
057            * @return the new expando row
058            */
059            public static com.liferay.portlet.expando.model.ExpandoRow createExpandoRow(
060                    long rowId) {
061                    return getService().createExpandoRow(rowId);
062            }
063    
064            /**
065            * Deletes the expando row with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param rowId the primary key of the expando row
068            * @return the expando row that was removed
069            * @throws PortalException if a expando row 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.ExpandoRow deleteExpandoRow(
073                    long rowId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteExpandoRow(rowId);
077            }
078    
079            /**
080            * Deletes the expando row from the database. Also notifies the appropriate model listeners.
081            *
082            * @param expandoRow the expando row
083            * @return the expando row that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.expando.model.ExpandoRow deleteExpandoRow(
087                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteExpandoRow(expandoRow);
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.ExpandoRowModelImpl}. 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.ExpandoRowModelImpl}. 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.ExpandoRow fetchExpandoRow(
168                    long rowId) throws com.liferay.portal.kernel.exception.SystemException {
169                    return getService().fetchExpandoRow(rowId);
170            }
171    
172            /**
173            * Returns the expando row with the primary key.
174            *
175            * @param rowId the primary key of the expando row
176            * @return the expando row
177            * @throws PortalException if a expando row with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public static com.liferay.portlet.expando.model.ExpandoRow getExpandoRow(
181                    long rowId)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getExpandoRow(rowId);
185            }
186    
187            public static com.liferay.portal.model.PersistedModel getPersistedModel(
188                    java.io.Serializable primaryKeyObj)
189                    throws com.liferay.portal.kernel.exception.PortalException,
190                            com.liferay.portal.kernel.exception.SystemException {
191                    return getService().getPersistedModel(primaryKeyObj);
192            }
193    
194            /**
195            * Returns a range of all the expando rows.
196            *
197            * <p>
198            * 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.ExpandoRowModelImpl}. 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.
199            * </p>
200            *
201            * @param start the lower bound of the range of expando rows
202            * @param end the upper bound of the range of expando rows (not inclusive)
203            * @return the range of expando rows
204            * @throws SystemException if a system exception occurred
205            */
206            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getExpandoRows(
207                    int start, int end)
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getExpandoRows(start, end);
210            }
211    
212            /**
213            * Returns the number of expando rows.
214            *
215            * @return the number of expando rows
216            * @throws SystemException if a system exception occurred
217            */
218            public static int getExpandoRowsCount()
219                    throws com.liferay.portal.kernel.exception.SystemException {
220                    return getService().getExpandoRowsCount();
221            }
222    
223            /**
224            * Updates the expando row in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
225            *
226            * @param expandoRow the expando row
227            * @return the expando row that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public static com.liferay.portlet.expando.model.ExpandoRow updateExpandoRow(
231                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
232                    throws com.liferay.portal.kernel.exception.SystemException {
233                    return getService().updateExpandoRow(expandoRow);
234            }
235    
236            /**
237            * Returns the Spring bean ID for this bean.
238            *
239            * @return the Spring bean ID for this bean
240            */
241            public static java.lang.String getBeanIdentifier() {
242                    return getService().getBeanIdentifier();
243            }
244    
245            /**
246            * Sets the Spring bean ID for this bean.
247            *
248            * @param beanIdentifier the Spring bean ID for this bean
249            */
250            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
251                    getService().setBeanIdentifier(beanIdentifier);
252            }
253    
254            public static com.liferay.portlet.expando.model.ExpandoRow addRow(
255                    long tableId, long classPK)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException {
258                    return getService().addRow(tableId, classPK);
259            }
260    
261            public static void deleteRow(
262                    com.liferay.portlet.expando.model.ExpandoRow row)
263                    throws com.liferay.portal.kernel.exception.SystemException {
264                    getService().deleteRow(row);
265            }
266    
267            public static void deleteRow(long rowId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    getService().deleteRow(rowId);
271            }
272    
273            public static void deleteRow(long tableId, long classPK)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    getService().deleteRow(tableId, classPK);
277            }
278    
279            public static void deleteRow(long companyId, long classNameId,
280                    java.lang.String tableName, long classPK)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteRow(companyId, classNameId, tableName, classPK);
284            }
285    
286            public static void deleteRow(long companyId, java.lang.String className,
287                    java.lang.String tableName, long classPK)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService().deleteRow(companyId, className, tableName, classPK);
291            }
292    
293            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getDefaultTableRows(
294                    long companyId, long classNameId, int start, int end)
295                    throws com.liferay.portal.kernel.exception.SystemException {
296                    return getService()
297                                       .getDefaultTableRows(companyId, classNameId, start, end);
298            }
299    
300            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getDefaultTableRows(
301                    long companyId, java.lang.String className, int start, int end)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    return getService().getDefaultTableRows(companyId, className, start, end);
304            }
305    
306            public static int getDefaultTableRowsCount(long companyId, long classNameId)
307                    throws com.liferay.portal.kernel.exception.SystemException {
308                    return getService().getDefaultTableRowsCount(companyId, classNameId);
309            }
310    
311            public static int getDefaultTableRowsCount(long companyId,
312                    java.lang.String className)
313                    throws com.liferay.portal.kernel.exception.SystemException {
314                    return getService().getDefaultTableRowsCount(companyId, className);
315            }
316    
317            public static com.liferay.portlet.expando.model.ExpandoRow getRow(
318                    long rowId)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException {
321                    return getService().getRow(rowId);
322            }
323    
324            public static com.liferay.portlet.expando.model.ExpandoRow getRow(
325                    long tableId, long classPK)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    return getService().getRow(tableId, classPK);
329            }
330    
331            public static com.liferay.portlet.expando.model.ExpandoRow getRow(
332                    long companyId, long classNameId, java.lang.String tableName,
333                    long classPK)
334                    throws com.liferay.portal.kernel.exception.SystemException {
335                    return getService().getRow(companyId, classNameId, tableName, classPK);
336            }
337    
338            public static com.liferay.portlet.expando.model.ExpandoRow getRow(
339                    long companyId, java.lang.String className, java.lang.String tableName,
340                    long classPK)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService().getRow(companyId, className, tableName, classPK);
343            }
344    
345            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
346                    long tableId, int start, int end)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().getRows(tableId, start, end);
349            }
350    
351            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
352                    long companyId, long classNameId, java.lang.String tableName,
353                    int start, int end)
354                    throws com.liferay.portal.kernel.exception.SystemException {
355                    return getService()
356                                       .getRows(companyId, classNameId, tableName, start, end);
357            }
358    
359            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
360                    long companyId, java.lang.String className, java.lang.String tableName,
361                    int start, int end)
362                    throws com.liferay.portal.kernel.exception.SystemException {
363                    return getService().getRows(companyId, className, tableName, start, end);
364            }
365    
366            /**
367            * @deprecated As of 6.1.0, replaced by {@link #getRows(long, String,
368            String, int, int)}
369            */
370            public static java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
371                    java.lang.String className, java.lang.String tableName, int start,
372                    int end) throws com.liferay.portal.kernel.exception.SystemException {
373                    return getService().getRows(className, tableName, start, end);
374            }
375    
376            public static int getRowsCount(long tableId)
377                    throws com.liferay.portal.kernel.exception.SystemException {
378                    return getService().getRowsCount(tableId);
379            }
380    
381            public static int getRowsCount(long companyId, long classNameId,
382                    java.lang.String tableName)
383                    throws com.liferay.portal.kernel.exception.SystemException {
384                    return getService().getRowsCount(companyId, classNameId, tableName);
385            }
386    
387            public static int getRowsCount(long companyId, java.lang.String className,
388                    java.lang.String tableName)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getRowsCount(companyId, className, tableName);
391            }
392    
393            /**
394            * @deprecated As of 6.1.0, replaced by {@link #getRowsCount(long, String,
395            String)}
396            */
397            public static int getRowsCount(java.lang.String className,
398                    java.lang.String tableName)
399                    throws com.liferay.portal.kernel.exception.SystemException {
400                    return getService().getRowsCount(className, tableName);
401            }
402    
403            public static ExpandoRowLocalService getService() {
404                    if (_service == null) {
405                            _service = (ExpandoRowLocalService)PortalBeanLocatorUtil.locate(ExpandoRowLocalService.class.getName());
406    
407                            ReferenceRegistry.registerReference(ExpandoRowLocalServiceUtil.class,
408                                    "_service");
409                    }
410    
411                    return _service;
412            }
413    
414            /**
415             * @deprecated As of 6.2.0
416             */
417            public void setService(ExpandoRowLocalService service) {
418            }
419    
420            private static ExpandoRowLocalService _service;
421    }