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