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.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.transaction.Isolation;
022    import com.liferay.portal.kernel.transaction.Propagation;
023    import com.liferay.portal.kernel.transaction.Transactional;
024    import com.liferay.portal.service.BaseLocalService;
025    import com.liferay.portal.service.PersistedModelLocalService;
026    
027    /**
028     * Provides the local service interface for MDRRule. Methods of this
029     * service will not have security checks based on the propagated JAAS
030     * credentials because this service can only be accessed from within the same
031     * VM.
032     *
033     * @author Edward C. Han
034     * @see MDRRuleLocalServiceUtil
035     * @see com.liferay.portlet.mobiledevicerules.service.base.MDRRuleLocalServiceBaseImpl
036     * @see com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl
037     * @generated
038     */
039    @ProviderType
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface MDRRuleLocalService extends BaseLocalService,
043            PersistedModelLocalService {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. Always use {@link MDRRuleLocalServiceUtil} to access the m d r rule local service. Add custom service methods to {@link com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
048             */
049    
050            /**
051            * Adds the m d r rule to the database. Also notifies the appropriate model listeners.
052            *
053            * @param mdrRule the m d r rule
054            * @return the m d r rule that was added
055            * @throws SystemException if a system exception occurred
056            */
057            public com.liferay.portlet.mobiledevicerules.model.MDRRule addMDRRule(
058                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new m d r rule with the primary key. Does not add the m d r rule to the database.
063            *
064            * @param ruleId the primary key for the new m d r rule
065            * @return the new m d r rule
066            */
067            public com.liferay.portlet.mobiledevicerules.model.MDRRule createMDRRule(
068                    long ruleId);
069    
070            /**
071            * Deletes the m d r rule with the primary key from the database. Also notifies the appropriate model listeners.
072            *
073            * @param ruleId the primary key of the m d r rule
074            * @return the m d r rule that was removed
075            * @throws PortalException if a m d r rule with the primary key could not be found
076            * @throws SystemException if a system exception occurred
077            */
078            public com.liferay.portlet.mobiledevicerules.model.MDRRule deleteMDRRule(
079                    long ruleId)
080                    throws com.liferay.portal.kernel.exception.PortalException,
081                            com.liferay.portal.kernel.exception.SystemException;
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 com.liferay.portlet.mobiledevicerules.model.MDRRule deleteMDRRule(
091                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
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 java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException;
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portlet.mobiledevicerules.model.MDRRule fetchMDRRule(
173                    long ruleId) throws com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns the m d r rule with the matching UUID and company.
177            *
178            * @param uuid the m d r rule's UUID
179            * @param companyId the primary key of the company
180            * @return the matching m d r rule, or <code>null</code> if a matching m d r rule could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.mobiledevicerules.model.MDRRule fetchMDRRuleByUuidAndCompanyId(
185                    java.lang.String uuid, long companyId)
186                    throws com.liferay.portal.kernel.exception.SystemException;
187    
188            /**
189            * Returns the m d r rule matching the UUID and group.
190            *
191            * @param uuid the m d r rule's UUID
192            * @param groupId the primary key of the group
193            * @return the matching m d r rule, or <code>null</code> if a matching m d r rule could not be found
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public com.liferay.portlet.mobiledevicerules.model.MDRRule fetchMDRRuleByUuidAndGroupId(
198                    java.lang.String uuid, long groupId)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the m d r rule with the primary key.
203            *
204            * @param ruleId the primary key of the m d r rule
205            * @return the m d r rule
206            * @throws PortalException if a m d r rule with the primary key could not be found
207            * @throws SystemException if a system exception occurred
208            */
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRule(
211                    long ruleId)
212                    throws com.liferay.portal.kernel.exception.PortalException,
213                            com.liferay.portal.kernel.exception.SystemException;
214    
215            @Override
216            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
217            public com.liferay.portal.model.PersistedModel getPersistedModel(
218                    java.io.Serializable primaryKeyObj)
219                    throws com.liferay.portal.kernel.exception.PortalException,
220                            com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Returns the m d r rule with the matching UUID and company.
224            *
225            * @param uuid the m d r rule's UUID
226            * @param companyId the primary key of the company
227            * @return the matching m d r rule
228            * @throws PortalException if a matching m d r rule could not be found
229            * @throws SystemException if a system exception occurred
230            */
231            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
232            public com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRuleByUuidAndCompanyId(
233                    java.lang.String uuid, long companyId)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            /**
238            * Returns the m d r rule matching the UUID and group.
239            *
240            * @param uuid the m d r rule's UUID
241            * @param groupId the primary key of the group
242            * @return the matching m d r rule
243            * @throws PortalException if a matching m d r rule could not be found
244            * @throws SystemException if a system exception occurred
245            */
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRuleByUuidAndGroupId(
248                    java.lang.String uuid, long groupId)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException;
251    
252            /**
253            * Returns a range of all the m d r rules.
254            *
255            * <p>
256            * 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.
257            * </p>
258            *
259            * @param start the lower bound of the range of m d r rules
260            * @param end the upper bound of the range of m d r rules (not inclusive)
261            * @return the range of m d r rules
262            * @throws SystemException if a system exception occurred
263            */
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getMDRRules(
266                    int start, int end)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            /**
270            * Returns the number of m d r rules.
271            *
272            * @return the number of m d r rules
273            * @throws SystemException if a system exception occurred
274            */
275            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
276            public int getMDRRulesCount()
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            /**
280            * Updates the m d r rule in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
281            *
282            * @param mdrRule the m d r rule
283            * @return the m d r rule that was updated
284            * @throws SystemException if a system exception occurred
285            */
286            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateMDRRule(
287                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
288                    throws com.liferay.portal.kernel.exception.SystemException;
289    
290            /**
291            * Returns the Spring bean ID for this bean.
292            *
293            * @return the Spring bean ID for this bean
294            */
295            public java.lang.String getBeanIdentifier();
296    
297            /**
298            * Sets the Spring bean ID for this bean.
299            *
300            * @param beanIdentifier the Spring bean ID for this bean
301            */
302            public void setBeanIdentifier(java.lang.String beanIdentifier);
303    
304            public com.liferay.portlet.mobiledevicerules.model.MDRRule addRule(
305                    long ruleGroupId,
306                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
307                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
308                    java.lang.String type, java.lang.String typeSettings,
309                    com.liferay.portal.service.ServiceContext serviceContext)
310                    throws com.liferay.portal.kernel.exception.PortalException,
311                            com.liferay.portal.kernel.exception.SystemException;
312    
313            public com.liferay.portlet.mobiledevicerules.model.MDRRule addRule(
314                    long ruleGroupId,
315                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
316                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
317                    java.lang.String type,
318                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
319                    com.liferay.portal.service.ServiceContext serviceContext)
320                    throws com.liferay.portal.kernel.exception.PortalException,
321                            com.liferay.portal.kernel.exception.SystemException;
322    
323            public com.liferay.portlet.mobiledevicerules.model.MDRRule copyRule(
324                    long ruleId, long ruleGroupId,
325                    com.liferay.portal.service.ServiceContext serviceContext)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException;
328    
329            public com.liferay.portlet.mobiledevicerules.model.MDRRule copyRule(
330                    com.liferay.portlet.mobiledevicerules.model.MDRRule rule,
331                    long ruleGroupId,
332                    com.liferay.portal.service.ServiceContext serviceContext)
333                    throws com.liferay.portal.kernel.exception.PortalException,
334                            com.liferay.portal.kernel.exception.SystemException;
335    
336            public void deleteRule(long ruleId)
337                    throws com.liferay.portal.kernel.exception.SystemException;
338    
339            public void deleteRule(
340                    com.liferay.portlet.mobiledevicerules.model.MDRRule rule)
341                    throws com.liferay.portal.kernel.exception.SystemException;
342    
343            public void deleteRules(long ruleGroupId)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public com.liferay.portlet.mobiledevicerules.model.MDRRule fetchRule(
348                    long ruleId) throws com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public com.liferay.portlet.mobiledevicerules.model.MDRRule getRule(
352                    long ruleId)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException;
355    
356            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
357            public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getRules(
358                    long ruleGroupId)
359                    throws com.liferay.portal.kernel.exception.SystemException;
360    
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getRules(
363                    long ruleGroupId, int start, int end)
364                    throws com.liferay.portal.kernel.exception.SystemException;
365    
366            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
367            public int getRulesCount(long ruleGroupId)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateRule(
371                    long ruleId, java.util.Map<java.util.Locale, java.lang.String> nameMap,
372                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
373                    java.lang.String type, java.lang.String typeSettings,
374                    com.liferay.portal.service.ServiceContext serviceContext)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException;
377    
378            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateRule(
379                    long ruleId, java.util.Map<java.util.Locale, java.lang.String> nameMap,
380                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
381                    java.lang.String type,
382                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
383                    com.liferay.portal.service.ServiceContext serviceContext)
384                    throws com.liferay.portal.kernel.exception.PortalException,
385                            com.liferay.portal.kernel.exception.SystemException;
386    }