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