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