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 UserTrackerPath. This utility wraps 024 * {@link com.liferay.portal.service.impl.UserTrackerPathLocalServiceImpl} 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 UserTrackerPathLocalService 032 * @see com.liferay.portal.service.base.UserTrackerPathLocalServiceBaseImpl 033 * @see com.liferay.portal.service.impl.UserTrackerPathLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class UserTrackerPathLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.UserTrackerPathLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the user tracker path to the database. Also notifies the appropriate model listeners. 046 * 047 * @param userTrackerPath the user tracker path 048 * @return the user tracker path that was added 049 */ 050 public static com.liferay.portal.model.UserTrackerPath addUserTrackerPath( 051 com.liferay.portal.model.UserTrackerPath userTrackerPath) { 052 return getService().addUserTrackerPath(userTrackerPath); 053 } 054 055 /** 056 * Creates a new user tracker path with the primary key. Does not add the user tracker path to the database. 057 * 058 * @param userTrackerPathId the primary key for the new user tracker path 059 * @return the new user tracker path 060 */ 061 public static com.liferay.portal.model.UserTrackerPath createUserTrackerPath( 062 long userTrackerPathId) { 063 return getService().createUserTrackerPath(userTrackerPathId); 064 } 065 066 /** 067 * @throws PortalException 068 */ 069 public static com.liferay.portal.model.PersistedModel deletePersistedModel( 070 com.liferay.portal.model.PersistedModel persistedModel) 071 throws com.liferay.portal.kernel.exception.PortalException { 072 return getService().deletePersistedModel(persistedModel); 073 } 074 075 /** 076 * Deletes the user tracker path from the database. Also notifies the appropriate model listeners. 077 * 078 * @param userTrackerPath the user tracker path 079 * @return the user tracker path that was removed 080 */ 081 public static com.liferay.portal.model.UserTrackerPath deleteUserTrackerPath( 082 com.liferay.portal.model.UserTrackerPath userTrackerPath) { 083 return getService().deleteUserTrackerPath(userTrackerPath); 084 } 085 086 /** 087 * Deletes the user tracker path with the primary key from the database. Also notifies the appropriate model listeners. 088 * 089 * @param userTrackerPathId the primary key of the user tracker path 090 * @return the user tracker path that was removed 091 * @throws PortalException if a user tracker path with the primary key could not be found 092 */ 093 public static com.liferay.portal.model.UserTrackerPath deleteUserTrackerPath( 094 long userTrackerPathId) 095 throws com.liferay.portal.kernel.exception.PortalException { 096 return getService().deleteUserTrackerPath(userTrackerPathId); 097 } 098 099 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 100 return getService().dynamicQuery(); 101 } 102 103 /** 104 * Performs a dynamic query on the database and returns the matching rows. 105 * 106 * @param dynamicQuery the dynamic query 107 * @return the matching rows 108 */ 109 public static <T> java.util.List<T> dynamicQuery( 110 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 111 return getService().dynamicQuery(dynamicQuery); 112 } 113 114 /** 115 * Performs a dynamic query on the database and returns a range of the matching rows. 116 * 117 * <p> 118 * 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.UserTrackerPathModelImpl}. 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query 122 * @param start the lower bound of the range of model instances 123 * @param end the upper bound of the range of model instances (not inclusive) 124 * @return the range of matching rows 125 */ 126 public static <T> java.util.List<T> dynamicQuery( 127 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 128 int end) { 129 return getService().dynamicQuery(dynamicQuery, start, end); 130 } 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.UserTrackerPathModelImpl}. 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 static <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 return getService() 150 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 151 } 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @return the number of rows matching the dynamic query 158 */ 159 public static long dynamicQueryCount( 160 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) { 161 return getService().dynamicQueryCount(dynamicQuery); 162 } 163 164 /** 165 * Returns the number of rows matching the dynamic query. 166 * 167 * @param dynamicQuery the dynamic query 168 * @param projection the projection to apply to the query 169 * @return the number of rows matching the dynamic query 170 */ 171 public static long dynamicQueryCount( 172 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 173 com.liferay.portal.kernel.dao.orm.Projection projection) { 174 return getService().dynamicQueryCount(dynamicQuery, projection); 175 } 176 177 public static com.liferay.portal.model.UserTrackerPath fetchUserTrackerPath( 178 long userTrackerPathId) { 179 return getService().fetchUserTrackerPath(userTrackerPathId); 180 } 181 182 public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() { 183 return getService().getActionableDynamicQuery(); 184 } 185 186 public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() { 187 return getService().getIndexableActionableDynamicQuery(); 188 } 189 190 /** 191 * Returns the OSGi service identifier. 192 * 193 * @return the OSGi service identifier 194 */ 195 public static java.lang.String getOSGiServiceIdentifier() { 196 return getService().getOSGiServiceIdentifier(); 197 } 198 199 public static com.liferay.portal.model.PersistedModel getPersistedModel( 200 java.io.Serializable primaryKeyObj) 201 throws com.liferay.portal.kernel.exception.PortalException { 202 return getService().getPersistedModel(primaryKeyObj); 203 } 204 205 /** 206 * Returns the user tracker path with the primary key. 207 * 208 * @param userTrackerPathId the primary key of the user tracker path 209 * @return the user tracker path 210 * @throws PortalException if a user tracker path with the primary key could not be found 211 */ 212 public static com.liferay.portal.model.UserTrackerPath getUserTrackerPath( 213 long userTrackerPathId) 214 throws com.liferay.portal.kernel.exception.PortalException { 215 return getService().getUserTrackerPath(userTrackerPathId); 216 } 217 218 /** 219 * Returns a range of all the user tracker paths. 220 * 221 * <p> 222 * 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.UserTrackerPathModelImpl}. 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. 223 * </p> 224 * 225 * @param start the lower bound of the range of user tracker paths 226 * @param end the upper bound of the range of user tracker paths (not inclusive) 227 * @return the range of user tracker paths 228 */ 229 public static java.util.List<com.liferay.portal.model.UserTrackerPath> getUserTrackerPaths( 230 int start, int end) { 231 return getService().getUserTrackerPaths(start, end); 232 } 233 234 public static java.util.List<com.liferay.portal.model.UserTrackerPath> getUserTrackerPaths( 235 long userTrackerId, int start, int end) { 236 return getService().getUserTrackerPaths(userTrackerId, start, end); 237 } 238 239 /** 240 * Returns the number of user tracker paths. 241 * 242 * @return the number of user tracker paths 243 */ 244 public static int getUserTrackerPathsCount() { 245 return getService().getUserTrackerPathsCount(); 246 } 247 248 /** 249 * Updates the user tracker path in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 250 * 251 * @param userTrackerPath the user tracker path 252 * @return the user tracker path that was updated 253 */ 254 public static com.liferay.portal.model.UserTrackerPath updateUserTrackerPath( 255 com.liferay.portal.model.UserTrackerPath userTrackerPath) { 256 return getService().updateUserTrackerPath(userTrackerPath); 257 } 258 259 public static UserTrackerPathLocalService getService() { 260 if (_service == null) { 261 _service = (UserTrackerPathLocalService)PortalBeanLocatorUtil.locate(UserTrackerPathLocalService.class.getName()); 262 263 ReferenceRegistry.registerReference(UserTrackerPathLocalServiceUtil.class, 264 "_service"); 265 } 266 267 return _service; 268 } 269 270 private static UserTrackerPathLocalService _service; 271 }