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 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) throws PortalException; 067 068 /** 069 * Creates a new system event with the primary key. Does not add the system event to the database. 070 * 071 * @param systemEventId the primary key for the new system event 072 * @return the new system event 073 */ 074 public com.liferay.portal.model.SystemEvent createSystemEvent( 075 long systemEventId); 076 077 /** 078 * @throws PortalException 079 */ 080 @Override 081 public com.liferay.portal.model.PersistedModel deletePersistedModel( 082 com.liferay.portal.model.PersistedModel persistedModel) 083 throws PortalException; 084 085 /** 086 * Deletes the system event from the database. Also notifies the appropriate model listeners. 087 * 088 * @param systemEvent the system event 089 * @return the system event that was removed 090 */ 091 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 092 public com.liferay.portal.model.SystemEvent deleteSystemEvent( 093 com.liferay.portal.model.SystemEvent systemEvent); 094 095 /** 096 * Deletes the system event with the primary key from the database. Also notifies the appropriate model listeners. 097 * 098 * @param systemEventId the primary key of the system event 099 * @return the system event that was removed 100 * @throws PortalException if a system event with the primary key could not be found 101 */ 102 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 103 public com.liferay.portal.model.SystemEvent deleteSystemEvent( 104 long systemEventId) throws PortalException; 105 106 public void deleteSystemEvents(long groupId); 107 108 public void deleteSystemEvents(long groupId, long systemEventSetKey); 109 110 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 111 112 /** 113 * Performs a dynamic query on the database and returns the matching rows. 114 * 115 * @param dynamicQuery the dynamic query 116 * @return the matching rows 117 */ 118 public <T> java.util.List<T> dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 120 121 /** 122 * Performs a dynamic query on the database and returns a range of the matching rows. 123 * 124 * <p> 125 * 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. 126 * </p> 127 * 128 * @param dynamicQuery the dynamic query 129 * @param start the lower bound of the range of model instances 130 * @param end the upper bound of the range of model instances (not inclusive) 131 * @return the range of matching rows 132 */ 133 public <T> java.util.List<T> dynamicQuery( 134 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 135 int end); 136 137 /** 138 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 139 * 140 * <p> 141 * 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. 142 * </p> 143 * 144 * @param dynamicQuery the dynamic query 145 * @param start the lower bound of the range of model instances 146 * @param end the upper bound of the range of model instances (not inclusive) 147 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 148 * @return the ordered range of matching rows 149 */ 150 public <T> java.util.List<T> dynamicQuery( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 152 int end, 153 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 154 155 /** 156 * Returns the number of rows matching the dynamic query. 157 * 158 * @param dynamicQuery the dynamic query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public long dynamicQueryCount( 172 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 173 com.liferay.portal.kernel.dao.orm.Projection projection); 174 175 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 176 public com.liferay.portal.model.SystemEvent fetchSystemEvent(long groupId, 177 long classNameId, long classPK, int type); 178 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public com.liferay.portal.model.SystemEvent fetchSystemEvent( 181 long systemEventId); 182 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 185 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 188 189 /** 190 * Returns the OSGi service identifier. 191 * 192 * @return the OSGi service identifier 193 */ 194 public java.lang.String getOSGiServiceIdentifier(); 195 196 @Override 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portal.model.PersistedModel getPersistedModel( 199 java.io.Serializable primaryKeyObj) throws 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) throws PortalException; 211 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public java.util.List<com.liferay.portal.model.SystemEvent> getSystemEvents( 214 long groupId, long classNameId, long classPK); 215 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public java.util.List<com.liferay.portal.model.SystemEvent> getSystemEvents( 218 long groupId, long classNameId, long classPK, int type); 219 220 /** 221 * Returns a range of all the system events. 222 * 223 * <p> 224 * 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. 225 * </p> 226 * 227 * @param start the lower bound of the range of system events 228 * @param end the upper bound of the range of system events (not inclusive) 229 * @return the range of system events 230 */ 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public java.util.List<com.liferay.portal.model.SystemEvent> getSystemEvents( 233 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 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 250 public com.liferay.portal.model.SystemEvent updateSystemEvent( 251 com.liferay.portal.model.SystemEvent systemEvent); 252 }