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