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