001 /** 002 * Copyright (c) 2000-present 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 public com.liferay.portlet.mobiledevicerules.model.MDRAction addAction( 052 long ruleGroupInstanceId, 053 java.util.Map<java.util.Locale, java.lang.String> nameMap, 054 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 055 java.lang.String type, java.lang.String typeSettings, 056 com.liferay.portal.service.ServiceContext serviceContext) 057 throws com.liferay.portal.kernel.exception.PortalException; 058 059 public com.liferay.portlet.mobiledevicerules.model.MDRAction addAction( 060 long ruleGroupInstanceId, 061 java.util.Map<java.util.Locale, java.lang.String> nameMap, 062 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 063 java.lang.String type, 064 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 065 com.liferay.portal.service.ServiceContext serviceContext) 066 throws com.liferay.portal.kernel.exception.PortalException; 067 068 /** 069 * Adds the m d r action to the database. Also notifies the appropriate model listeners. 070 * 071 * @param mdrAction the m d r action 072 * @return the m d r action that was added 073 */ 074 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 075 public com.liferay.portlet.mobiledevicerules.model.MDRAction addMDRAction( 076 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction); 077 078 /** 079 * Creates a new m d r action with the primary key. Does not add the m d r action to the database. 080 * 081 * @param actionId the primary key for the new m d r action 082 * @return the new m d r action 083 */ 084 public com.liferay.portlet.mobiledevicerules.model.MDRAction createMDRAction( 085 long actionId); 086 087 @com.liferay.portal.kernel.systemevent.SystemEvent(type = SystemEventConstants.TYPE_DELETE) 088 public void deleteAction( 089 com.liferay.portlet.mobiledevicerules.model.MDRAction action); 090 091 public void deleteAction(long actionId); 092 093 public void deleteActions(long ruleGroupInstanceId); 094 095 /** 096 * Deletes the m d r action with the primary key from the database. Also notifies the appropriate model listeners. 097 * 098 * @param actionId the primary key of the m d r action 099 * @return the m d r action that was removed 100 * @throws PortalException if a m d r action with the primary key could not be found 101 */ 102 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 103 public com.liferay.portlet.mobiledevicerules.model.MDRAction deleteMDRAction( 104 long actionId) 105 throws com.liferay.portal.kernel.exception.PortalException; 106 107 /** 108 * Deletes the m d r action from the database. Also notifies the appropriate model listeners. 109 * 110 * @param mdrAction the m d r action 111 * @return the m d r action that was removed 112 */ 113 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 114 public com.liferay.portlet.mobiledevicerules.model.MDRAction deleteMDRAction( 115 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction); 116 117 /** 118 * @throws PortalException 119 */ 120 @Override 121 public com.liferay.portal.model.PersistedModel deletePersistedModel( 122 com.liferay.portal.model.PersistedModel persistedModel) 123 throws com.liferay.portal.kernel.exception.PortalException; 124 125 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 126 127 /** 128 * Performs a dynamic query on the database and returns the matching rows. 129 * 130 * @param dynamicQuery the dynamic query 131 * @return the matching rows 132 */ 133 public <T> java.util.List<T> dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 135 136 /** 137 * Performs a dynamic query on the database and returns a range of the matching rows. 138 * 139 * <p> 140 * 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. 141 * </p> 142 * 143 * @param dynamicQuery the dynamic query 144 * @param start the lower bound of the range of model instances 145 * @param end the upper bound of the range of model instances (not inclusive) 146 * @return the range of matching rows 147 */ 148 public <T> java.util.List<T> dynamicQuery( 149 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 150 int end); 151 152 /** 153 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 154 * 155 * <p> 156 * 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. 157 * </p> 158 * 159 * @param dynamicQuery the dynamic query 160 * @param start the lower bound of the range of model instances 161 * @param end the upper bound of the range of model instances (not inclusive) 162 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 163 * @return the ordered range of matching rows 164 */ 165 public <T> java.util.List<T> dynamicQuery( 166 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 167 int end, 168 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 169 170 /** 171 * Returns the number of rows matching the dynamic query. 172 * 173 * @param dynamicQuery the dynamic query 174 * @return the number of rows matching the dynamic query 175 */ 176 public long dynamicQueryCount( 177 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 178 179 /** 180 * Returns the number of rows matching the dynamic query. 181 * 182 * @param dynamicQuery the dynamic query 183 * @param projection the projection to apply to the query 184 * @return the number of rows matching the dynamic query 185 */ 186 public long dynamicQueryCount( 187 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 188 com.liferay.portal.kernel.dao.orm.Projection projection); 189 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portlet.mobiledevicerules.model.MDRAction fetchAction( 192 long actionId); 193 194 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 195 public com.liferay.portlet.mobiledevicerules.model.MDRAction fetchMDRAction( 196 long actionId); 197 198 /** 199 * Returns the m d r action matching the UUID and group. 200 * 201 * @param uuid the m d r action's UUID 202 * @param groupId the primary key of the group 203 * @return the matching m d r action, or <code>null</code> if a matching m d r action could not be found 204 */ 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public com.liferay.portlet.mobiledevicerules.model.MDRAction fetchMDRActionByUuidAndGroupId( 207 java.lang.String uuid, long groupId); 208 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portlet.mobiledevicerules.model.MDRAction getAction( 211 long actionId) 212 throws com.liferay.portal.kernel.exception.PortalException; 213 214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 215 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 216 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getActions( 219 long ruleGroupInstanceId); 220 221 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 222 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getActions( 223 long ruleGroupInstanceId, int start, int end); 224 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public int getActionsCount(long ruleGroupInstanceId); 227 228 /** 229 * Returns the Spring bean ID for this bean. 230 * 231 * @return the Spring bean ID for this bean 232 */ 233 public java.lang.String getBeanIdentifier(); 234 235 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 236 public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery( 237 com.liferay.portal.kernel.lar.PortletDataContext portletDataContext); 238 239 /** 240 * Returns the m d r action with the primary key. 241 * 242 * @param actionId the primary key of the m d r action 243 * @return the m d r action 244 * @throws PortalException if a m d r action with the primary key could not be found 245 */ 246 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 247 public com.liferay.portlet.mobiledevicerules.model.MDRAction getMDRAction( 248 long actionId) 249 throws com.liferay.portal.kernel.exception.PortalException; 250 251 /** 252 * Returns the m d r action matching the UUID and group. 253 * 254 * @param uuid the m d r action's UUID 255 * @param groupId the primary key of the group 256 * @return the matching m d r action 257 * @throws PortalException if a matching m d r action could not be found 258 */ 259 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 260 public com.liferay.portlet.mobiledevicerules.model.MDRAction getMDRActionByUuidAndGroupId( 261 java.lang.String uuid, long groupId) 262 throws com.liferay.portal.kernel.exception.PortalException; 263 264 /** 265 * Returns a range of all the m d r actions. 266 * 267 * <p> 268 * 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. 269 * </p> 270 * 271 * @param start the lower bound of the range of m d r actions 272 * @param end the upper bound of the range of m d r actions (not inclusive) 273 * @return the range of m d r actions 274 */ 275 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 276 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getMDRActions( 277 int start, int end); 278 279 /** 280 * Returns all the m d r actions matching the UUID and company. 281 * 282 * @param uuid the UUID of the m d r actions 283 * @param companyId the primary key of the company 284 * @return the matching m d r actions, or an empty list if no matches were found 285 */ 286 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 287 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getMDRActionsByUuidAndCompanyId( 288 java.lang.String uuid, long companyId); 289 290 /** 291 * Returns a range of m d r actions matching the UUID and company. 292 * 293 * @param uuid the UUID of the m d r actions 294 * @param companyId the primary key of the company 295 * @param start the lower bound of the range of m d r actions 296 * @param end the upper bound of the range of m d r actions (not inclusive) 297 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 298 * @return the range of matching m d r actions, or an empty list if no matches were found 299 */ 300 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 301 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getMDRActionsByUuidAndCompanyId( 302 java.lang.String uuid, long companyId, int start, int end, 303 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.mobiledevicerules.model.MDRAction> orderByComparator); 304 305 /** 306 * Returns the number of m d r actions. 307 * 308 * @return the number of m d r actions 309 */ 310 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 311 public int getMDRActionsCount(); 312 313 @Override 314 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 315 public com.liferay.portal.model.PersistedModel getPersistedModel( 316 java.io.Serializable primaryKeyObj) 317 throws com.liferay.portal.kernel.exception.PortalException; 318 319 /** 320 * Sets the Spring bean ID for this bean. 321 * 322 * @param beanIdentifier the Spring bean ID for this bean 323 */ 324 public void setBeanIdentifier(java.lang.String beanIdentifier); 325 326 public com.liferay.portlet.mobiledevicerules.model.MDRAction updateAction( 327 long actionId, 328 java.util.Map<java.util.Locale, java.lang.String> nameMap, 329 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 330 java.lang.String type, java.lang.String typeSettings, 331 com.liferay.portal.service.ServiceContext serviceContext) 332 throws com.liferay.portal.kernel.exception.PortalException; 333 334 public com.liferay.portlet.mobiledevicerules.model.MDRAction updateAction( 335 long actionId, 336 java.util.Map<java.util.Locale, java.lang.String> nameMap, 337 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 338 java.lang.String type, 339 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 340 com.liferay.portal.service.ServiceContext serviceContext) 341 throws com.liferay.portal.kernel.exception.PortalException; 342 343 /** 344 * Updates the m d r action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 345 * 346 * @param mdrAction the m d r action 347 * @return the m d r action that was updated 348 */ 349 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 350 public com.liferay.portlet.mobiledevicerules.model.MDRAction updateMDRAction( 351 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction); 352 }