001 /** 002 * Copyright (c) 2000-2012 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 action 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 MDRActionLocalServiceUtil 034 * @see com.liferay.portlet.mobiledevicerules.service.base.MDRActionLocalServiceBaseImpl 035 * @see com.liferay.portlet.mobiledevicerules.service.impl.MDRActionLocalServiceImpl 036 * @generated 037 */ 038 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 039 PortalException.class, SystemException.class}) 040 public interface MDRActionLocalService extends BaseLocalService, 041 PersistedModelLocalService { 042 /* 043 * NOTE FOR DEVELOPERS: 044 * 045 * 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. 046 */ 047 048 /** 049 * Adds the m d r action to the database. Also notifies the appropriate model listeners. 050 * 051 * @param mdrAction the m d r action 052 * @return the m d r action that was added 053 * @throws SystemException if a system exception occurred 054 */ 055 public com.liferay.portlet.mobiledevicerules.model.MDRAction addMDRAction( 056 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction) 057 throws com.liferay.portal.kernel.exception.SystemException; 058 059 /** 060 * Creates a new m d r action with the primary key. Does not add the m d r action to the database. 061 * 062 * @param actionId the primary key for the new m d r action 063 * @return the new m d r action 064 */ 065 public com.liferay.portlet.mobiledevicerules.model.MDRAction createMDRAction( 066 long actionId); 067 068 /** 069 * Deletes the m d r action with the primary key from the database. Also notifies the appropriate model listeners. 070 * 071 * @param actionId the primary key of the m d r action 072 * @return the m d r action that was removed 073 * @throws PortalException if a m d r action with the primary key could not be found 074 * @throws SystemException if a system exception occurred 075 */ 076 public com.liferay.portlet.mobiledevicerules.model.MDRAction deleteMDRAction( 077 long actionId) 078 throws com.liferay.portal.kernel.exception.PortalException, 079 com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Deletes the m d r action from the database. Also notifies the appropriate model listeners. 083 * 084 * @param mdrAction the m d r action 085 * @return the m d r action that was removed 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portlet.mobiledevicerules.model.MDRAction deleteMDRAction( 089 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction) 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. 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. 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. 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. 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.MDRAction fetchMDRAction( 158 long actionId) 159 throws com.liferay.portal.kernel.exception.SystemException; 160 161 /** 162 * Returns the m d r action with the primary key. 163 * 164 * @param actionId the primary key of the m d r action 165 * @return the m d r action 166 * @throws PortalException if a m d r action with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public com.liferay.portlet.mobiledevicerules.model.MDRAction getMDRAction( 171 long actionId) 172 throws com.liferay.portal.kernel.exception.PortalException, 173 com.liferay.portal.kernel.exception.SystemException; 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.PersistedModel getPersistedModel( 177 java.io.Serializable primaryKeyObj) 178 throws com.liferay.portal.kernel.exception.PortalException, 179 com.liferay.portal.kernel.exception.SystemException; 180 181 /** 182 * Returns the m d r action with the UUID in the group. 183 * 184 * @param uuid the UUID of m d r action 185 * @param groupId the group id of the m d r action 186 * @return the m d r action 187 * @throws PortalException if a m d r action with the UUID in the group could not be found 188 * @throws SystemException if a system exception occurred 189 */ 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public com.liferay.portlet.mobiledevicerules.model.MDRAction getMDRActionByUuidAndGroupId( 192 java.lang.String uuid, long groupId) 193 throws com.liferay.portal.kernel.exception.PortalException, 194 com.liferay.portal.kernel.exception.SystemException; 195 196 /** 197 * Returns a range of all the m d r actions. 198 * 199 * <p> 200 * 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. 201 * </p> 202 * 203 * @param start the lower bound of the range of m d r actions 204 * @param end the upper bound of the range of m d r actions (not inclusive) 205 * @return the range of m d r actions 206 * @throws SystemException if a system exception occurred 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getMDRActions( 210 int start, int end) 211 throws com.liferay.portal.kernel.exception.SystemException; 212 213 /** 214 * Returns the number of m d r actions. 215 * 216 * @return the number of m d r actions 217 * @throws SystemException if a system exception occurred 218 */ 219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 220 public int getMDRActionsCount() 221 throws com.liferay.portal.kernel.exception.SystemException; 222 223 /** 224 * Updates the m d r action in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 225 * 226 * @param mdrAction the m d r action 227 * @return the m d r action that was updated 228 * @throws SystemException if a system exception occurred 229 */ 230 public com.liferay.portlet.mobiledevicerules.model.MDRAction updateMDRAction( 231 com.liferay.portlet.mobiledevicerules.model.MDRAction mdrAction) 232 throws com.liferay.portal.kernel.exception.SystemException; 233 234 /** 235 * Returns the Spring bean ID for this bean. 236 * 237 * @return the Spring bean ID for this bean 238 */ 239 public java.lang.String getBeanIdentifier(); 240 241 /** 242 * Sets the Spring bean ID for this bean. 243 * 244 * @param beanIdentifier the Spring bean ID for this bean 245 */ 246 public void setBeanIdentifier(java.lang.String beanIdentifier); 247 248 public com.liferay.portlet.mobiledevicerules.model.MDRAction addAction( 249 long ruleGroupInstanceId, 250 java.util.Map<java.util.Locale, java.lang.String> nameMap, 251 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 252 java.lang.String type, java.lang.String typeSettings, 253 com.liferay.portal.service.ServiceContext serviceContext) 254 throws com.liferay.portal.kernel.exception.PortalException, 255 com.liferay.portal.kernel.exception.SystemException; 256 257 public com.liferay.portlet.mobiledevicerules.model.MDRAction addAction( 258 long ruleGroupInstanceId, 259 java.util.Map<java.util.Locale, java.lang.String> nameMap, 260 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 261 java.lang.String type, 262 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 263 com.liferay.portal.service.ServiceContext serviceContext) 264 throws com.liferay.portal.kernel.exception.PortalException, 265 com.liferay.portal.kernel.exception.SystemException; 266 267 public void deleteAction(long actionId) 268 throws com.liferay.portal.kernel.exception.SystemException; 269 270 public void deleteAction( 271 com.liferay.portlet.mobiledevicerules.model.MDRAction action) 272 throws com.liferay.portal.kernel.exception.SystemException; 273 274 public void deleteActions(long ruleGroupInstanceId) 275 throws com.liferay.portal.kernel.exception.SystemException; 276 277 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 278 public com.liferay.portlet.mobiledevicerules.model.MDRAction fetchAction( 279 long actionId) 280 throws com.liferay.portal.kernel.exception.SystemException; 281 282 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 283 public com.liferay.portlet.mobiledevicerules.model.MDRAction getAction( 284 long actionId) 285 throws com.liferay.portal.kernel.exception.PortalException, 286 com.liferay.portal.kernel.exception.SystemException; 287 288 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 289 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getActions( 290 long ruleGroupInstanceId) 291 throws com.liferay.portal.kernel.exception.SystemException; 292 293 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 294 public java.util.List<com.liferay.portlet.mobiledevicerules.model.MDRAction> getActions( 295 long ruleGroupInstanceId, int start, int end) 296 throws com.liferay.portal.kernel.exception.SystemException; 297 298 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 299 public int getActionsCount(long ruleGroupInstanceId) 300 throws com.liferay.portal.kernel.exception.SystemException; 301 302 public com.liferay.portlet.mobiledevicerules.model.MDRAction updateAction( 303 long actionId, 304 java.util.Map<java.util.Locale, java.lang.String> nameMap, 305 java.util.Map<java.util.Locale, java.lang.String> descriptionMap, 306 java.lang.String type, java.lang.String typeSettings, 307 com.liferay.portal.service.ServiceContext serviceContext) 308 throws com.liferay.portal.kernel.exception.PortalException, 309 com.liferay.portal.kernel.exception.SystemException; 310 311 public com.liferay.portlet.mobiledevicerules.model.MDRAction updateAction( 312 long actionId, 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, 316 com.liferay.portal.kernel.util.UnicodeProperties typeSettingsProperties, 317 com.liferay.portal.service.ServiceContext serviceContext) 318 throws com.liferay.portal.kernel.exception.PortalException, 319 com.liferay.portal.kernel.exception.SystemException; 320 }