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.bean.PortalBeanLocatorUtil; 020 import com.liferay.portal.kernel.util.ReferenceRegistry; 021 022 /** 023 * Provides the local service utility for UserTracker. This utility wraps 024 * {@link com.liferay.portal.service.impl.UserTrackerLocalServiceImpl} and is the 025 * primary access point for service operations in application layer code running 026 * on the local server. Methods of this service will not have security checks 027 * based on the propagated JAAS credentials because this service can only be 028 * accessed from within the same VM. 029 * 030 * @author Brian Wing Shun Chan 031 * @see UserTrackerLocalService 032 * @see com.liferay.portal.service.base.UserTrackerLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.UserTrackerLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class UserTrackerLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserTrackerLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 public static com.liferay.portal.model.UserTracker addUserTracker( 044 long companyId, long userId, java.util.Date modifiedDate, 045 java.lang.String sessionId, java.lang.String remoteAddr, 046 java.lang.String remoteHost, java.lang.String userAgent, 047 java.util.List<com.liferay.portal.model.UserTrackerPath> userTrackerPaths) { 048 return getService() 049 .addUserTracker(companyId, userId, modifiedDate, sessionId, 050 remoteAddr, remoteHost, userAgent, userTrackerPaths); 051 } 052 053 /** 054 * Adds the user tracker to the database. Also notifies the appropriate model listeners. 055 * 056 * @param userTracker the user tracker 057 * @return the user tracker that was added 058 */ 059 public static com.liferay.portal.model.UserTracker addUserTracker( 060 com.liferay.portal.model.UserTracker userTracker) { 061 return getService().addUserTracker(userTracker); 062 } 063 064 /** 065 * Creates a new user tracker with the primary key. Does not add the user tracker to the database. 066 * 067 * @param userTrackerId the primary key for the new user tracker 068 * @return the new user tracker 069 */ 070 public static com.liferay.portal.model.UserTracker createUserTracker( 071 long userTrackerId) { 072 return getService().createUserTracker(userTrackerId); 073 } 074 075 /** 076 * @throws PortalException 077 */ 078 public static com.liferay.portal.model.PersistedModel deletePersistedModel( 079 com.liferay.portal.model.PersistedModel persistedModel) 080 throws com.liferay.portal.kernel.exception.PortalException { 081 return getService().deletePersistedModel(persistedModel); 082 } 083 084 /** 085 * Deletes the user tracker from the database. Also notifies the appropriate model listeners. 086 * 087 * @param userTracker the user tracker 088 * @return the user tracker that was removed 089 */ 090 public static com.liferay.portal.model.UserTracker deleteUserTracker( 091 com.liferay.portal.model.UserTracker userTracker) { 092 return getService().deleteUserTracker(userTracker); 093 } 094 095 /** 096 * Deletes the user tracker with the primary key from the database. Also notifies the appropriate model listeners. 097 * 098 * @param userTrackerId the primary key of the user tracker 099 * @return the user tracker that was removed 100 * @throws PortalException if a user tracker with the primary key could not be found 101 */ 102 public static com.liferay.portal.model.UserTracker deleteUserTracker( 103 long userTrackerId) 104 throws com.liferay.portal.kernel.exception.PortalException { 105 return getService().deleteUserTracker(userTrackerId); 106 } 107 108 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 109 return getService().dynamicQuery(); 110 } 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 static <T> java.util.List<T> dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 120 return getService().dynamicQuery(dynamicQuery); 121 } 122 123 /** 124 * Performs a dynamic query on the database and returns a range of the matching rows. 125 * 126 * <p> 127 * 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. 128 * </p> 129 * 130 * @param dynamicQuery the dynamic query 131 * @param start the lower bound of the range of model instances 132 * @param end the upper bound of the range of model instances (not inclusive) 133 * @return the range of matching rows 134 */ 135 public static <T> java.util.List<T> dynamicQuery( 136 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 137 int end) { 138 return getService().dynamicQuery(dynamicQuery, start, end); 139 } 140 141 /** 142 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 143 * 144 * <p> 145 * 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. 146 * </p> 147 * 148 * @param dynamicQuery the dynamic query 149 * @param start the lower bound of the range of model instances 150 * @param end the upper bound of the range of model instances (not inclusive) 151 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 152 * @return the ordered range of matching rows 153 */ 154 public static <T> java.util.List<T> dynamicQuery( 155 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 156 int end, 157 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) { 158 return getService() 159 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 160 } 161 162 /** 163 * Returns the number of rows matching the dynamic query. 164 * 165 * @param dynamicQuery the dynamic query 166 * @return the number of rows matching the dynamic query 167 */ 168 public static long dynamicQueryCount( 169 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 170 return getService().dynamicQueryCount(dynamicQuery); 171 } 172 173 /** 174 * Returns the number of rows matching the dynamic query. 175 * 176 * @param dynamicQuery the dynamic query 177 * @param projection the projection to apply to the query 178 * @return the number of rows matching the dynamic query 179 */ 180 public static long dynamicQueryCount( 181 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 182 com.liferay.portal.kernel.dao.orm.Projection projection) { 183 return getService().dynamicQueryCount(dynamicQuery, projection); 184 } 185 186 public static com.liferay.portal.model.UserTracker fetchUserTracker( 187 long userTrackerId) { 188 return getService().fetchUserTracker(userTrackerId); 189 } 190 191 public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { 192 return getService().getActionableDynamicQuery(); 193 } 194 195 public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { 196 return getService().getIndexableActionableDynamicQuery(); 197 } 198 199 /** 200 * Returns the OSGi service identifier. 201 * 202 * @return the OSGi service identifier 203 */ 204 public static java.lang.String getOSGiServiceIdentifier() { 205 return getService().getOSGiServiceIdentifier(); 206 } 207 208 public static com.liferay.portal.model.PersistedModel getPersistedModel( 209 java.io.Serializable primaryKeyObj) 210 throws com.liferay.portal.kernel.exception.PortalException { 211 return getService().getPersistedModel(primaryKeyObj); 212 } 213 214 /** 215 * Returns the user tracker with the primary key. 216 * 217 * @param userTrackerId the primary key of the user tracker 218 * @return the user tracker 219 * @throws PortalException if a user tracker with the primary key could not be found 220 */ 221 public static com.liferay.portal.model.UserTracker getUserTracker( 222 long userTrackerId) 223 throws com.liferay.portal.kernel.exception.PortalException { 224 return getService().getUserTracker(userTrackerId); 225 } 226 227 public static java.util.List<com.liferay.portal.model.UserTracker> getUserTrackers( 228 long companyId, int start, int end) { 229 return getService().getUserTrackers(companyId, start, end); 230 } 231 232 /** 233 * Returns a range of all the user trackers. 234 * 235 * <p> 236 * 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. 237 * </p> 238 * 239 * @param start the lower bound of the range of user trackers 240 * @param end the upper bound of the range of user trackers (not inclusive) 241 * @return the range of user trackers 242 */ 243 public static java.util.List<com.liferay.portal.model.UserTracker> getUserTrackers( 244 int start, int end) { 245 return getService().getUserTrackers(start, end); 246 } 247 248 /** 249 * Returns the number of user trackers. 250 * 251 * @return the number of user trackers 252 */ 253 public static int getUserTrackersCount() { 254 return getService().getUserTrackersCount(); 255 } 256 257 /** 258 * Updates the user tracker in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 259 * 260 * @param userTracker the user tracker 261 * @return the user tracker that was updated 262 */ 263 public static com.liferay.portal.model.UserTracker updateUserTracker( 264 com.liferay.portal.model.UserTracker userTracker) { 265 return getService().updateUserTracker(userTracker); 266 } 267 268 public static UserTrackerLocalService getService() { 269 if (_service == null) { 270 _service = (UserTrackerLocalService)PortalBeanLocatorUtil.locate(UserTrackerLocalService.class.getName()); 271 272 ReferenceRegistry.registerReference(UserTrackerLocalServiceUtil.class, 273 "_service"); 274 } 275 276 return _service; 277 } 278 279 private static UserTrackerLocalService _service; 280 }