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