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