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.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.search.Indexable; 026 import com.liferay.portal.kernel.search.IndexableType; 027 import com.liferay.portal.kernel.transaction.Isolation; 028 import com.liferay.portal.kernel.transaction.Propagation; 029 import com.liferay.portal.kernel.transaction.Transactional; 030 import com.liferay.portal.kernel.util.OrderByComparator; 031 import com.liferay.portal.model.PersistedModel; 032 import com.liferay.portal.model.SystemEvent; 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 public SystemEvent addSystemEvent(long companyId, 061 java.lang.String className, long classPK, java.lang.String classUuid, 062 java.lang.String referrerClassName, int type, java.lang.String extraData) 063 throws PortalException; 064 065 /** 066 * Adds the system event to the database. Also notifies the appropriate model listeners. 067 * 068 * @param systemEvent the system event 069 * @return the system event that was added 070 */ 071 @Indexable(type = IndexableType.REINDEX) 072 public SystemEvent addSystemEvent(SystemEvent systemEvent); 073 074 public SystemEvent addSystemEvent(long userId, long groupId, 075 java.lang.String className, long classPK, java.lang.String classUuid, 076 java.lang.String referrerClassName, int type, java.lang.String extraData) 077 throws PortalException; 078 079 /** 080 * Creates a new system event with the primary key. Does not add the system event to the database. 081 * 082 * @param systemEventId the primary key for the new system event 083 * @return the new system event 084 */ 085 public SystemEvent createSystemEvent(long systemEventId); 086 087 /** 088 * @throws PortalException 089 */ 090 @Override 091 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 092 throws PortalException; 093 094 /** 095 * Deletes the system event from the database. Also notifies the appropriate model listeners. 096 * 097 * @param systemEvent the system event 098 * @return the system event that was removed 099 */ 100 @Indexable(type = IndexableType.DELETE) 101 public SystemEvent deleteSystemEvent(SystemEvent systemEvent); 102 103 /** 104 * Deletes the system event with the primary key from the database. Also notifies the appropriate model listeners. 105 * 106 * @param systemEventId the primary key of the system event 107 * @return the system event that was removed 108 * @throws PortalException if a system event with the primary key could not be found 109 */ 110 @Indexable(type = IndexableType.DELETE) 111 public SystemEvent deleteSystemEvent(long systemEventId) 112 throws PortalException; 113 114 public void deleteSystemEvents(long groupId); 115 116 public void deleteSystemEvents(long groupId, long systemEventSetKey); 117 118 public DynamicQuery dynamicQuery(); 119 120 /** 121 * Performs a dynamic query on the database and returns the matching rows. 122 * 123 * @param dynamicQuery the dynamic query 124 * @return the matching rows 125 */ 126 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 127 128 /** 129 * Performs a dynamic query on the database and returns a range of the matching rows. 130 * 131 * <p> 132 * 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. 133 * </p> 134 * 135 * @param dynamicQuery the dynamic query 136 * @param start the lower bound of the range of model instances 137 * @param end the upper bound of the range of model instances (not inclusive) 138 * @return the range of matching rows 139 */ 140 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 141 int end); 142 143 /** 144 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 145 * 146 * <p> 147 * 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. 148 * </p> 149 * 150 * @param dynamicQuery the dynamic query 151 * @param start the lower bound of the range of model instances 152 * @param end the upper bound of the range of model instances (not inclusive) 153 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 154 * @return the ordered range of matching rows 155 */ 156 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 157 int end, OrderByComparator<T> orderByComparator); 158 159 /** 160 * Returns the number of rows matching the dynamic query. 161 * 162 * @param dynamicQuery the dynamic query 163 * @return the number of rows matching the dynamic query 164 */ 165 public long dynamicQueryCount(DynamicQuery dynamicQuery); 166 167 /** 168 * Returns the number of rows matching the dynamic query. 169 * 170 * @param dynamicQuery the dynamic query 171 * @param projection the projection to apply to the query 172 * @return the number of rows matching the dynamic query 173 */ 174 public long dynamicQueryCount(DynamicQuery dynamicQuery, 175 Projection projection); 176 177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 178 public SystemEvent fetchSystemEvent(long groupId, long classNameId, 179 long classPK, int type); 180 181 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 182 public SystemEvent fetchSystemEvent(long systemEventId); 183 184 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 185 public ActionableDynamicQuery getActionableDynamicQuery(); 186 187 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 188 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 189 190 /** 191 * Returns the OSGi service identifier. 192 * 193 * @return the OSGi service identifier 194 */ 195 public java.lang.String getOSGiServiceIdentifier(); 196 197 @Override 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 200 throws PortalException; 201 202 /** 203 * Returns the system event with the primary key. 204 * 205 * @param systemEventId the primary key of the system event 206 * @return the system event 207 * @throws PortalException if a system event with the primary key could not be found 208 */ 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public SystemEvent getSystemEvent(long systemEventId) 211 throws PortalException; 212 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public List<SystemEvent> getSystemEvents(long groupId, long classNameId, 215 long classPK); 216 217 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 218 public List<SystemEvent> getSystemEvents(long groupId, long classNameId, 219 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 List<SystemEvent> getSystemEvents(int start, int end); 234 235 /** 236 * Returns the number of system events. 237 * 238 * @return the number of system events 239 */ 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public int getSystemEventsCount(); 242 243 /** 244 * Updates the system event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 245 * 246 * @param systemEvent the system event 247 * @return the system event that was updated 248 */ 249 @Indexable(type = IndexableType.REINDEX) 250 public SystemEvent updateSystemEvent(SystemEvent systemEvent); 251 }