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.counter.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 Counter. This utility wraps 024 * {@link com.liferay.counter.service.impl.CounterLocalServiceImpl} 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 CounterLocalService 032 * @see com.liferay.counter.service.base.CounterLocalServiceBaseImpl 033 * @see com.liferay.counter.service.impl.CounterLocalServiceImpl 034 * @generated 035 */ 036 @ProviderType 037 public class CounterLocalServiceUtil { 038 /* 039 * NOTE FOR DEVELOPERS: 040 * 041 * Never modify this class directly. Add custom service methods to {@link com.liferay.counter.service.impl.CounterLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 042 */ 043 044 /** 045 * Adds the counter to the database. Also notifies the appropriate model listeners. 046 * 047 * @param counter the counter 048 * @return the counter that was added 049 */ 050 public static com.liferay.counter.model.Counter addCounter( 051 com.liferay.counter.model.Counter counter) { 052 return getService().addCounter(counter); 053 } 054 055 /** 056 * Creates a new counter with the primary key. Does not add the counter to the database. 057 * 058 * @param name the primary key for the new counter 059 * @return the new counter 060 */ 061 public static com.liferay.counter.model.Counter createCounter( 062 java.lang.String name) { 063 return getService().createCounter(name); 064 } 065 066 /** 067 * Deletes the counter from the database. Also notifies the appropriate model listeners. 068 * 069 * @param counter the counter 070 * @return the counter that was removed 071 */ 072 public static com.liferay.counter.model.Counter deleteCounter( 073 com.liferay.counter.model.Counter counter) { 074 return getService().deleteCounter(counter); 075 } 076 077 /** 078 * Deletes the counter with the primary key from the database. Also notifies the appropriate model listeners. 079 * 080 * @param name the primary key of the counter 081 * @return the counter that was removed 082 * @throws PortalException if a counter with the primary key could not be found 083 */ 084 public static com.liferay.counter.model.Counter deleteCounter( 085 java.lang.String name) 086 throws com.liferay.portal.kernel.exception.PortalException { 087 return getService().deleteCounter(name); 088 } 089 090 /** 091 * @throws PortalException 092 */ 093 public static com.liferay.portal.model.PersistedModel deletePersistedModel( 094 com.liferay.portal.model.PersistedModel persistedModel) 095 throws com.liferay.portal.kernel.exception.PortalException { 096 return getService().deletePersistedModel(persistedModel); 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.counter.model.impl.CounterModelImpl}. 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.counter.model.impl.CounterModelImpl}. 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.counter.model.Counter fetchCounter( 178 java.lang.String name) { 179 return getService().fetchCounter(name); 180 } 181 182 /** 183 * Returns the counter with the primary key. 184 * 185 * @param name the primary key of the counter 186 * @return the counter 187 * @throws PortalException if a counter with the primary key could not be found 188 */ 189 public static com.liferay.counter.model.Counter getCounter( 190 java.lang.String name) 191 throws com.liferay.portal.kernel.exception.PortalException { 192 return getService().getCounter(name); 193 } 194 195 /** 196 * Returns a range of all the counters. 197 * 198 * <p> 199 * 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.counter.model.impl.CounterModelImpl}. 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. 200 * </p> 201 * 202 * @param start the lower bound of the range of counters 203 * @param end the upper bound of the range of counters (not inclusive) 204 * @return the range of counters 205 */ 206 public static java.util.List<com.liferay.counter.model.Counter> getCounters( 207 int start, int end) { 208 return getService().getCounters(start, end); 209 } 210 211 /** 212 * Returns the number of counters. 213 * 214 * @return the number of counters 215 */ 216 public static int getCountersCount() { 217 return getService().getCountersCount(); 218 } 219 220 public static java.util.List<java.lang.String> getNames() { 221 return getService().getNames(); 222 } 223 224 /** 225 * Returns the OSGi service identifier. 226 * 227 * @return the OSGi service identifier 228 */ 229 public static java.lang.String getOSGiServiceIdentifier() { 230 return getService().getOSGiServiceIdentifier(); 231 } 232 233 public static com.liferay.portal.model.PersistedModel getPersistedModel( 234 java.io.Serializable primaryKeyObj) 235 throws com.liferay.portal.kernel.exception.PortalException { 236 return getService().getPersistedModel(primaryKeyObj); 237 } 238 239 public static long increment() { 240 return getService().increment(); 241 } 242 243 public static long increment(java.lang.String name) { 244 return getService().increment(name); 245 } 246 247 public static long increment(java.lang.String name, int size) { 248 return getService().increment(name, size); 249 } 250 251 public static void rename(java.lang.String oldName, java.lang.String newName) { 252 getService().rename(oldName, newName); 253 } 254 255 public static void reset(java.lang.String name) { 256 getService().reset(name); 257 } 258 259 public static void reset(java.lang.String name, long size) { 260 getService().reset(name, size); 261 } 262 263 /** 264 * Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 265 * 266 * @param counter the counter 267 * @return the counter that was updated 268 */ 269 public static com.liferay.counter.model.Counter updateCounter( 270 com.liferay.counter.model.Counter counter) { 271 return getService().updateCounter(counter); 272 } 273 274 public static CounterLocalService getService() { 275 if (_service == null) { 276 _service = (CounterLocalService)PortalBeanLocatorUtil.locate(CounterLocalService.class.getName()); 277 278 ReferenceRegistry.registerReference(CounterLocalServiceUtil.class, 279 "_service"); 280 } 281 282 return _service; 283 } 284 285 private static CounterLocalService _service; 286 }