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.portal.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 026 /** 027 * Provides the local service interface for SystemEvent. Methods of this 028 * service will not have security checks based on the propagated JAAS 029 * credentials because this service can only be accessed from within the same 030 * VM. 031 * 032 * @author Brian Wing Shun Chan 033 * @see SystemEventLocalServiceUtil 034 * @see com.liferay.portal.service.base.SystemEventLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.SystemEventLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface SystemEventLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link SystemEventLocalServiceUtil} to access the system event local service. Add custom service methods to {@link com.liferay.portal.service.impl.SystemEventLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 public com.liferay.portal.model.SystemEvent addSystemEvent(long companyId, 049 java.lang.String className, long classPK, java.lang.String classUuid, 050 java.lang.String referrerClassName, int type, java.lang.String extraData) 051 throws com.liferay.portal.kernel.exception.PortalException; 052 053 /** 054 * Adds the system event to the database. Also notifies the appropriate model listeners. 055 * 056 * @param systemEvent the system event 057 * @return the system event that was added 058 */ 059 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 060 public com.liferay.portal.model.SystemEvent addSystemEvent( 061 com.liferay.portal.model.SystemEvent systemEvent); 062 063 public com.liferay.portal.model.SystemEvent addSystemEvent(long userId, 064 long groupId, java.lang.String className, long classPK, 065 java.lang.String classUuid, java.lang.String referrerClassName, 066 int type, java.lang.String extraData) 067 throws com.liferay.portal.kernel.exception.PortalException; 068 069 /** 070 * Creates a new system event with the primary key. Does not add the system event to the database. 071 * 072 * @param systemEventId the primary key for the new system event 073 * @return the new system event 074 */ 075 public com.liferay.portal.model.SystemEvent createSystemEvent( 076 long systemEventId); 077 078 /** 079 * @throws PortalException 080 */ 081 @Override 082 public com.liferay.portal.model.PersistedModel deletePersistedModel( 083 com.liferay.portal.model.PersistedModel persistedModel) 084 throws com.liferay.portal.kernel.exception.PortalException; 085 086 /** 087 * Deletes the system event from the database. Also notifies the appropriate model listeners. 088 * 089 * @param systemEvent the system event 090 * @return the system event that was removed 091 */ 092 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 093 public com.liferay.portal.model.SystemEvent deleteSystemEvent( 094 com.liferay.portal.model.SystemEvent systemEvent); 095 096 /** 097 * Deletes the system event with the primary key from the database. Also notifies the appropriate model listeners. 098 * 099 * @param systemEventId the primary key of the system event 100 * @return the system event that was removed 101 * @throws PortalException if a system event with the primary key could not be found 102 */ 103 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 104 public com.liferay.portal.model.SystemEvent deleteSystemEvent( 105 long systemEventId) 106 throws com.liferay.portal.kernel.exception.PortalException; 107 108 public void deleteSystemEvents(long groupId); 109 110 public void deleteSystemEvents(long groupId, long systemEventSetKey); 111 112 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 113 114 /** 115 * Performs a dynamic query on the database and returns the matching rows. 116 * 117 * @param dynamicQuery the dynamic query 118 * @return the matching rows 119 */ 120 public <T> java.util.List<T> dynamicQuery( 121 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 122 123 /** 124 * Performs a dynamic query on the database and returns a 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.portal.model.impl.SystemEventModelImpl}. 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 * @return the range of matching rows 134 */ 135 public <T> java.util.List<T> dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end); 138 139 /** 140 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 141 * 142 * <p> 143 * 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.portal.model.impl.SystemEventModelImpl}. 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. 144 * </p> 145 * 146 * @param dynamicQuery the dynamic query 147 * @param start the lower bound of the range of model instances 148 * @param end the upper bound of the range of model instances (not inclusive) 149 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 150 * @return the ordered range of matching rows 151 */ 152 public <T> java.util.List<T> dynamicQuery( 153 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 154 int end, 155 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 156 157 /** 158 * Returns the number of rows matching the dynamic query. 159 * 160 * @param dynamicQuery the dynamic query 161 * @return the number of rows matching the dynamic query 162 */ 163 public long dynamicQueryCount( 164 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 165 166 /** 167 * Returns the number of rows matching the dynamic query. 168 * 169 * @param dynamicQuery the dynamic query 170 * @param projection the projection to apply to the query 171 * @return the number of rows matching the dynamic query 172 */ 173 public long dynamicQueryCount( 174 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 175 com.liferay.portal.kernel.dao.orm.Projection projection); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public com.liferay.portal.model.SystemEvent fetchSystemEvent(long groupId, 179 long classNameId, long classPK, int type); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public com.liferay.portal.model.SystemEvent fetchSystemEvent( 183 long systemEventId); 184 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 187 188 /** 189 * Returns the Spring bean ID for this bean. 190 * 191 * @return the Spring bean ID for this bean 192 */ 193 public java.lang.String getBeanIdentifier(); 194 195 @Override 196 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 197 public com.liferay.portal.model.PersistedModel getPersistedModel( 198 java.io.Serializable primaryKeyObj) 199 throws com.liferay.portal.kernel.exception.PortalException; 200 201 /** 202 * Returns the system event with the primary key. 203 * 204 * @param systemEventId the primary key of the system event 205 * @return the system event 206 * @throws PortalException if a system event with the primary key could not be found 207 */ 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public com.liferay.portal.model.SystemEvent getSystemEvent( 210 long systemEventId) 211 throws com.liferay.portal.kernel.exception.PortalException; 212 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public java.util.List<com.liferay.portal.model.SystemEvent> getSystemEvents( 215 long groupId, long classNameId, long classPK); 216 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public java.util.List<com.liferay.portal.model.SystemEvent> getSystemEvents( 219 long groupId, long classNameId, long classPK, int type); 220 221 /** 222 * Returns a range of all the system events. 223 * 224 * <p> 225 * 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.portal.model.impl.SystemEventModelImpl}. 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. 226 * </p> 227 * 228 * @param start the lower bound of the range of system events 229 * @param end the upper bound of the range of system events (not inclusive) 230 * @return the range of system events 231 */ 232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 233 public java.util.List<com.liferay.portal.model.SystemEvent> getSystemEvents( 234 int start, int end); 235 236 /** 237 * Returns the number of system events. 238 * 239 * @return the number of system events 240 */ 241 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 242 public int getSystemEventsCount(); 243 244 /** 245 * Sets the Spring bean ID for this bean. 246 * 247 * @param beanIdentifier the Spring bean ID for this bean 248 */ 249 public void setBeanIdentifier(java.lang.String beanIdentifier); 250 251 /** 252 * Updates the system event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 253 * 254 * @param systemEvent the system event 255 * @return the system event that was updated 256 */ 257 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 258 public com.liferay.portal.model.SystemEvent updateSystemEvent( 259 com.liferay.portal.model.SystemEvent systemEvent); 260 }