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 BrowserTracker. 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 BrowserTrackerLocalServiceUtil 034 * @see com.liferay.portal.service.base.BrowserTrackerLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.BrowserTrackerLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface BrowserTrackerLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link BrowserTrackerLocalServiceUtil} to access the browser tracker local service. Add custom service methods to {@link com.liferay.portal.service.impl.BrowserTrackerLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the browser tracker to the database. Also notifies the appropriate model listeners. 051 * 052 * @param browserTracker the browser tracker 053 * @return the browser tracker that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.BrowserTracker addBrowserTracker( 057 com.liferay.portal.model.BrowserTracker browserTracker); 058 059 /** 060 * Creates a new browser tracker with the primary key. Does not add the browser tracker to the database. 061 * 062 * @param browserTrackerId the primary key for the new browser tracker 063 * @return the new browser tracker 064 */ 065 public com.liferay.portal.model.BrowserTracker createBrowserTracker( 066 long browserTrackerId); 067 068 /** 069 * Deletes the browser tracker from the database. Also notifies the appropriate model listeners. 070 * 071 * @param browserTracker the browser tracker 072 * @return the browser tracker that was removed 073 */ 074 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 075 public com.liferay.portal.model.BrowserTracker deleteBrowserTracker( 076 com.liferay.portal.model.BrowserTracker browserTracker); 077 078 /** 079 * Deletes the browser tracker with the primary key from the database. Also notifies the appropriate model listeners. 080 * 081 * @param browserTrackerId the primary key of the browser tracker 082 * @return the browser tracker that was removed 083 * @throws PortalException if a browser tracker with the primary key could not be found 084 */ 085 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 086 public com.liferay.portal.model.BrowserTracker deleteBrowserTracker( 087 long browserTrackerId) throws PortalException; 088 089 /** 090 * @throws PortalException 091 */ 092 @Override 093 public com.liferay.portal.model.PersistedModel deletePersistedModel( 094 com.liferay.portal.model.PersistedModel persistedModel) 095 throws PortalException; 096 097 public void deleteUserBrowserTracker(long userId); 098 099 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 100 101 /** 102 * Performs a dynamic query on the database and returns the matching rows. 103 * 104 * @param dynamicQuery the dynamic query 105 * @return the matching rows 106 */ 107 public <T> java.util.List<T> dynamicQuery( 108 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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.BrowserTrackerModelImpl}. 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 */ 122 public <T> java.util.List<T> dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end); 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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.BrowserTrackerModelImpl}. 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 */ 139 public <T> java.util.List<T> dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 143 144 /** 145 * Returns the number of rows matching the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows matching the dynamic query 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 162 com.liferay.portal.kernel.dao.orm.Projection projection); 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.portal.model.BrowserTracker fetchBrowserTracker( 166 long browserTrackerId); 167 168 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 169 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 170 171 /** 172 * Returns the browser tracker with the primary key. 173 * 174 * @param browserTrackerId the primary key of the browser tracker 175 * @return the browser tracker 176 * @throws PortalException if a browser tracker with the primary key could not be found 177 */ 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portal.model.BrowserTracker getBrowserTracker( 180 long browserTrackerId) throws PortalException; 181 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.portal.model.BrowserTracker getBrowserTracker( 184 long userId, long browserKey); 185 186 /** 187 * Returns a range of all the browser trackers. 188 * 189 * <p> 190 * 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.BrowserTrackerModelImpl}. 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. 191 * </p> 192 * 193 * @param start the lower bound of the range of browser trackers 194 * @param end the upper bound of the range of browser trackers (not inclusive) 195 * @return the range of browser trackers 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public java.util.List<com.liferay.portal.model.BrowserTracker> getBrowserTrackers( 199 int start, int end); 200 201 /** 202 * Returns the number of browser trackers. 203 * 204 * @return the number of browser trackers 205 */ 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public int getBrowserTrackersCount(); 208 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 211 212 /** 213 * Returns the OSGi service identifier. 214 * 215 * @return the OSGi service identifier 216 */ 217 public java.lang.String getOSGiServiceIdentifier(); 218 219 @Override 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public com.liferay.portal.model.PersistedModel getPersistedModel( 222 java.io.Serializable primaryKeyObj) throws PortalException; 223 224 /** 225 * Updates the browser tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 226 * 227 * @param browserTracker the browser tracker 228 * @return the browser tracker that was updated 229 */ 230 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 231 public com.liferay.portal.model.BrowserTracker updateBrowserTracker( 232 com.liferay.portal.model.BrowserTracker browserTracker); 233 234 public com.liferay.portal.model.BrowserTracker updateBrowserTracker( 235 long userId, long browserKey); 236 }