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