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.mobiledevicerules.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 m d r rule local service. This utility wraps {@link com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl} 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 Edward C. Han
028     * @see MDRRuleLocalService
029     * @see com.liferay.portlet.mobiledevicerules.service.base.MDRRuleLocalServiceBaseImpl
030     * @see com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl
031     * @generated
032     */
033    public class MDRRuleLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the m d r rule to the database. Also notifies the appropriate model listeners.
042            *
043            * @param mdrRule the m d r rule
044            * @return the m d r rule that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portlet.mobiledevicerules.model.MDRRule addMDRRule(
048                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addMDRRule(mdrRule);
051            }
052    
053            /**
054            * Creates a new m d r rule with the primary key. Does not add the m d r rule to the database.
055            *
056            * @param ruleId the primary key for the new m d r rule
057            * @return the new m d r rule
058            */
059            public static com.liferay.portlet.mobiledevicerules.model.MDRRule createMDRRule(
060                    long ruleId) {
061                    return getService().createMDRRule(ruleId);
062            }
063    
064            /**
065            * Deletes the m d r rule with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param ruleId the primary key of the m d r rule
068            * @return the m d r rule that was removed
069            * @throws PortalException if a m d r rule with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portlet.mobiledevicerules.model.MDRRule deleteMDRRule(
073                    long ruleId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteMDRRule(ruleId);
077            }
078    
079            /**
080            * Deletes the m d r rule from the database. Also notifies the appropriate model listeners.
081            *
082            * @param mdrRule the m d r rule
083            * @return the m d r rule that was removed
084            * @throws SystemException if a system exception occurred
085            */
086            public static com.liferay.portlet.mobiledevicerules.model.MDRRule deleteMDRRule(
087                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return getService().deleteMDRRule(mdrRule);
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.mobiledevicerules.model.impl.MDRRuleModelImpl}. 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.mobiledevicerules.model.impl.MDRRuleModelImpl}. 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.mobiledevicerules.model.MDRRule fetchMDRRule(
168                    long ruleId) throws com.liferay.portal.kernel.exception.SystemException {
169                    return getService().fetchMDRRule(ruleId);
170            }
171    
172            /**
173            * Returns the m d r rule with the primary key.
174            *
175            * @param ruleId the primary key of the m d r rule
176            * @return the m d r rule
177            * @throws PortalException if a m d r rule with the primary key could not be found
178            * @throws SystemException if a system exception occurred
179            */
180            public static com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRule(
181                    long ruleId)
182                    throws com.liferay.portal.kernel.exception.PortalException,
183                            com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getMDRRule(ruleId);
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 the m d r rule matching the UUID and group.
196            *
197            * @param uuid the m d r rule's UUID
198            * @param groupId the primary key of the group
199            * @return the matching m d r rule
200            * @throws PortalException if a matching m d r rule could not be found
201            * @throws SystemException if a system exception occurred
202            */
203            public static com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRuleByUuidAndGroupId(
204                    java.lang.String uuid, long groupId)
205                    throws com.liferay.portal.kernel.exception.PortalException,
206                            com.liferay.portal.kernel.exception.SystemException {
207                    return getService().getMDRRuleByUuidAndGroupId(uuid, groupId);
208            }
209    
210            /**
211            * Returns a range of all the m d r rules.
212            *
213            * <p>
214            * 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.mobiledevicerules.model.impl.MDRRuleModelImpl}. 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.
215            * </p>
216            *
217            * @param start the lower bound of the range of m d r rules
218            * @param end the upper bound of the range of m d r rules (not inclusive)
219            * @return the range of m d r rules
220            * @throws SystemException if a system exception occurred
221            */
222            public static java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getMDRRules(
223                    int start, int end)
224                    throws com.liferay.portal.kernel.exception.SystemException {
225                    return getService().getMDRRules(start, end);
226            }
227    
228            /**
229            * Returns the number of m d r rules.
230            *
231            * @return the number of m d r rules
232            * @throws SystemException if a system exception occurred
233            */
234            public static int getMDRRulesCount()
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().getMDRRulesCount();
237            }
238    
239            /**
240            * Updates the m d r rule in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param mdrRule the m d r rule
243            * @return the m d r rule that was updated
244            * @throws SystemException if a system exception occurred
245            */
246            public static com.liferay.portlet.mobiledevicerules.model.MDRRule updateMDRRule(
247                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
248                    throws com.liferay.portal.kernel.exception.SystemException {
249                    return getService().updateMDRRule(mdrRule);
250            }
251    
252            /**
253            * Returns the Spring bean ID for this bean.
254            *
255            * @return the Spring bean ID for this bean
256            */
257            public static java.lang.String getBeanIdentifier() {
258                    return getService().getBeanIdentifier();
259            }
260    
261            /**
262            * Sets the Spring bean ID for this bean.
263            *
264            * @param beanIdentifier the Spring bean ID for this bean
265            */
266            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
267                    getService().setBeanIdentifier(beanIdentifier);
268            }
269    
270            public static com.liferay.portlet.mobiledevicerules.model.MDRRule addRule(
271                    long ruleGroupId,
272                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
273                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
274                    java.lang.String type, java.lang.String typeSettings,
275                    com.liferay.portal.service.ServiceContext serviceContext)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException {
278                    return getService()
279                                       .addRule(ruleGroupId, nameMap, descriptionMap, type,
280                            typeSettings, serviceContext);
281            }
282    
283            public static com.liferay.portlet.mobiledevicerules.model.MDRRule addRule(
284                    long ruleGroupId,
285                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
286                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
287                    java.lang.String type,
288                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
289                    com.liferay.portal.service.ServiceContext serviceContext)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException {
292                    return getService()
293                                       .addRule(ruleGroupId, nameMap, descriptionMap, type,
294                            typeSettingsProperties, serviceContext);
295            }
296    
297            public static com.liferay.portlet.mobiledevicerules.model.MDRRule copyRule(
298                    long ruleId, long ruleGroupId,
299                    com.liferay.portal.service.ServiceContext serviceContext)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    return getService().copyRule(ruleId, ruleGroupId, serviceContext);
303            }
304    
305            public static com.liferay.portlet.mobiledevicerules.model.MDRRule copyRule(
306                    com.liferay.portlet.mobiledevicerules.model.MDRRule rule,
307                    long ruleGroupId,
308                    com.liferay.portal.service.ServiceContext serviceContext)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    return getService().copyRule(rule, ruleGroupId, serviceContext);
312            }
313    
314            public static void deleteRule(long ruleId)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    getService().deleteRule(ruleId);
317            }
318    
319            public static void deleteRule(
320                    com.liferay.portlet.mobiledevicerules.model.MDRRule rule)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    getService().deleteRule(rule);
323            }
324    
325            public static void deleteRules(long ruleGroupId)
326                    throws com.liferay.portal.kernel.exception.SystemException {
327                    getService().deleteRules(ruleGroupId);
328            }
329    
330            public static com.liferay.portlet.mobiledevicerules.model.MDRRule fetchRule(
331                    long ruleId) throws com.liferay.portal.kernel.exception.SystemException {
332                    return getService().fetchRule(ruleId);
333            }
334    
335            public static com.liferay.portlet.mobiledevicerules.model.MDRRule getRule(
336                    long ruleId)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    return getService().getRule(ruleId);
340            }
341    
342            public static java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getRules(
343                    long ruleGroupId)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService().getRules(ruleGroupId);
346            }
347    
348            public static java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getRules(
349                    long ruleGroupId, int start, int end)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService().getRules(ruleGroupId, start, end);
352            }
353    
354            public static int getRulesCount(long ruleGroupId)
355                    throws com.liferay.portal.kernel.exception.SystemException {
356                    return getService().getRulesCount(ruleGroupId);
357            }
358    
359            public static com.liferay.portlet.mobiledevicerules.model.MDRRule updateRule(
360                    long ruleId, java.util.Map<java.util.Locale, java.lang.String> nameMap,
361                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
362                    java.lang.String type, java.lang.String typeSettings,
363                    com.liferay.portal.service.ServiceContext serviceContext)
364                    throws com.liferay.portal.kernel.exception.PortalException,
365                            com.liferay.portal.kernel.exception.SystemException {
366                    return getService()
367                                       .updateRule(ruleId, nameMap, descriptionMap, type,
368                            typeSettings, serviceContext);
369            }
370    
371            public static com.liferay.portlet.mobiledevicerules.model.MDRRule updateRule(
372                    long ruleId, java.util.Map<java.util.Locale, java.lang.String> nameMap,
373                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
374                    java.lang.String type,
375                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
376                    com.liferay.portal.service.ServiceContext serviceContext)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService()
380                                       .updateRule(ruleId, nameMap, descriptionMap, type,
381                            typeSettingsProperties, serviceContext);
382            }
383    
384            public static MDRRuleLocalService getService() {
385                    if (_service == null) {
386                            _service = (MDRRuleLocalService)PortalBeanLocatorUtil.locate(MDRRuleLocalService.class.getName());
387    
388                            ReferenceRegistry.registerReference(MDRRuleLocalServiceUtil.class,
389                                    "_service");
390                    }
391    
392                    return _service;
393            }
394    
395            /**
396             * @deprecated As of 6.2.0
397             */
398            public void setService(MDRRuleLocalService service) {
399            }
400    
401            private static MDRRuleLocalService _service;
402    }