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.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.BaseLocalService;
023    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * The interface for the m d r rule local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Edward C. Han
033     * @see MDRRuleLocalServiceUtil
034     * @see com.liferay.portlet.mobiledevicerules.service.base.MDRRuleLocalServiceBaseImpl
035     * @see com.liferay.portlet.mobiledevicerules.service.impl.MDRRuleLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface MDRRuleLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the m d r rule to the database. Also notifies the appropriate model listeners.
050            *
051            * @param mdrRule the m d r rule
052            * @return the m d r rule that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.mobiledevicerules.model.MDRRule addMDRRule(
056                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new m d r rule with the primary key. Does not add the m d r rule to the database.
061            *
062            * @param ruleId the primary key for the new m d r rule
063            * @return the new m d r rule
064            */
065            public com.liferay.portlet.mobiledevicerules.model.MDRRule createMDRRule(
066                    long ruleId);
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 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    
081            /**
082            * Deletes the m d r rule from the database. Also notifies the appropriate model listeners.
083            *
084            * @param mdrRule the m d r rule
085            * @return the m d r rule that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.mobiledevicerules.model.MDRRule deleteMDRRule(
089                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.mobiledevicerules.model.MDRRule fetchMDRRule(
158                    long ruleId) throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the m d r rule with the primary key.
162            *
163            * @param ruleId the primary key of the m d r rule
164            * @return the m d r rule
165            * @throws PortalException if a m d r rule with the primary key could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRule(
170                    long ruleId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.PersistedModel getPersistedModel(
176                    java.io.Serializable primaryKeyObj)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns the m d r rule with the UUID in the group.
182            *
183            * @param uuid the UUID of m d r rule
184            * @param groupId the group id of the m d r rule
185            * @return the m d r rule
186            * @throws PortalException if a m d r rule with the UUID in the group could not be found
187            * @throws SystemException if a system exception occurred
188            */
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portlet.mobiledevicerules.model.MDRRule getMDRRuleByUuidAndGroupId(
191                    java.lang.String uuid, long groupId)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Returns a range of all the m d r rules.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of m d r rules
203            * @param end the upper bound of the range of m d r rules (not inclusive)
204            * @return the range of m d r rules
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getMDRRules(
209                    int start, int end)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Returns the number of m d r rules.
214            *
215            * @return the number of m d r rules
216            * @throws SystemException if a system exception occurred
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getMDRRulesCount()
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the m d r rule in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param mdrRule the m d r rule
226            * @return the m d r rule that was updated
227            * @throws SystemException if a system exception occurred
228            */
229            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateMDRRule(
230                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule)
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            /**
234            * Updates the m d r rule in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
235            *
236            * @param mdrRule the m d r rule
237            * @param merge whether to merge the m d r rule with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
238            * @return the m d r rule that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateMDRRule(
242                    com.liferay.portlet.mobiledevicerules.model.MDRRule mdrRule,
243                    boolean merge)
244                    throws com.liferay.portal.kernel.exception.SystemException;
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public java.lang.String getBeanIdentifier();
252    
253            /**
254            * Sets the Spring bean ID for this bean.
255            *
256            * @param beanIdentifier the Spring bean ID for this bean
257            */
258            public void setBeanIdentifier(java.lang.String beanIdentifier);
259    
260            public com.liferay.portlet.mobiledevicerules.model.MDRRule addRule(
261                    long ruleGroupId,
262                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
263                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
264                    java.lang.String type, java.lang.String typeSettings,
265                    com.liferay.portal.service.ServiceContext serviceContext)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public com.liferay.portlet.mobiledevicerules.model.MDRRule addRule(
270                    long ruleGroupId,
271                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
272                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
273                    java.lang.String type,
274                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
275                    com.liferay.portal.service.ServiceContext serviceContext)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public com.liferay.portlet.mobiledevicerules.model.MDRRule copyRule(
280                    long ruleId, long ruleGroupId,
281                    com.liferay.portal.service.ServiceContext serviceContext)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException;
284    
285            public com.liferay.portlet.mobiledevicerules.model.MDRRule copyRule(
286                    com.liferay.portlet.mobiledevicerules.model.MDRRule rule,
287                    long ruleGroupId,
288                    com.liferay.portal.service.ServiceContext serviceContext)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public void deleteRule(long ruleId)
293                    throws com.liferay.portal.kernel.exception.SystemException;
294    
295            public void deleteRule(
296                    com.liferay.portlet.mobiledevicerules.model.MDRRule rule)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            public void deleteRules(long ruleGroupId)
300                    throws com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public com.liferay.portlet.mobiledevicerules.model.MDRRule fetchRule(
304                    long ruleId) throws com.liferay.portal.kernel.exception.SystemException;
305    
306            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307            public com.liferay.portlet.mobiledevicerules.model.MDRRule getRule(
308                    long ruleId)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getRules(
314                    long ruleGroupId)
315                    throws com.liferay.portal.kernel.exception.SystemException;
316    
317            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
318            public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRRule> getRules(
319                    long ruleGroupId, int start, int end)
320                    throws com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public int getRulesCount(long ruleGroupId)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateRule(
327                    long ruleId, java.util.Map<java.util.Locale, java.lang.String> nameMap,
328                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
329                    java.lang.String type, java.lang.String typeSettings,
330                    com.liferay.portal.service.ServiceContext serviceContext)
331                    throws com.liferay.portal.kernel.exception.PortalException,
332                            com.liferay.portal.kernel.exception.SystemException;
333    
334            public com.liferay.portlet.mobiledevicerules.model.MDRRule updateRule(
335                    long ruleId, 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,
338                    com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties,
339                    com.liferay.portal.service.ServiceContext serviceContext)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException;
342    }