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.exception.PortalException; 020 import com.liferay.portal.kernel.exception.SystemException; 021 import com.liferay.portal.kernel.search.IndexableType; 022 import com.liferay.portal.kernel.transaction.Isolation; 023 import com.liferay.portal.kernel.transaction.Propagation; 024 import com.liferay.portal.kernel.transaction.Transactional; 025 import com.liferay.portal.service.BaseLocalService; 026 import com.liferay.portal.service.PersistedModelLocalService; 027 028 /** 029 * Provides the local service interface for Counter. Methods of this 030 * service will not have security checks based on the propagated JAAS 031 * credentials because this service can only be accessed from within the same 032 * VM. 033 * 034 * @author Brian Wing Shun Chan 035 * @see CounterLocalServiceUtil 036 * @see com.liferay.counter.service.base.CounterLocalServiceBaseImpl 037 * @see com.liferay.counter.service.impl.CounterLocalServiceImpl 038 * @generated 039 */ 040 @ProviderType 041 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 042 PortalException.class, SystemException.class}) 043 public interface CounterLocalService extends BaseLocalService, 044 PersistedModelLocalService { 045 /* 046 * NOTE FOR DEVELOPERS: 047 * 048 * Never modify or reference this interface directly. Always use {@link CounterLocalServiceUtil} to access the counter local service. Add custom service methods to {@link com.liferay.counter.service.impl.CounterLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 049 */ 050 051 /** 052 * Adds the counter to the database. Also notifies the appropriate model listeners. 053 * 054 * @param counter the counter 055 * @return the counter that was added 056 */ 057 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 058 public com.liferay.counter.model.Counter addCounter( 059 com.liferay.counter.model.Counter counter); 060 061 /** 062 * Creates a new counter with the primary key. Does not add the counter to the database. 063 * 064 * @param name the primary key for the new counter 065 * @return the new counter 066 */ 067 public com.liferay.counter.model.Counter createCounter( 068 java.lang.String name); 069 070 /** 071 * Deletes the counter from the database. Also notifies the appropriate model listeners. 072 * 073 * @param counter the counter 074 * @return the counter that was removed 075 */ 076 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 077 public com.liferay.counter.model.Counter deleteCounter( 078 com.liferay.counter.model.Counter counter); 079 080 /** 081 * Deletes the counter with the primary key from the database. Also notifies the appropriate model listeners. 082 * 083 * @param name the primary key of the counter 084 * @return the counter that was removed 085 * @throws PortalException if a counter with the primary key could not be found 086 */ 087 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 088 public com.liferay.counter.model.Counter deleteCounter( 089 java.lang.String name) throws PortalException; 090 091 /** 092 * @throws PortalException 093 */ 094 @Override 095 public com.liferay.portal.model.PersistedModel deletePersistedModel( 096 com.liferay.portal.model.PersistedModel persistedModel) 097 throws PortalException; 098 099 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 100 101 /** 102 * Performs a dynamic query on the database and returns the matching rows. 103 * 104 * @param dynamicQuery the dynamic query 105 * @return the matching rows 106 */ 107 public <T> java.util.List<T> dynamicQuery( 108 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 */ 122 public <T> java.util.List<T> dynamicQuery( 123 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 124 int end); 125 126 /** 127 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 128 * 129 * <p> 130 * 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. 131 * </p> 132 * 133 * @param dynamicQuery the dynamic query 134 * @param start the lower bound of the range of model instances 135 * @param end the upper bound of the range of model instances (not inclusive) 136 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 137 * @return the ordered range of matching rows 138 */ 139 public <T> java.util.List<T> dynamicQuery( 140 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 141 int end, 142 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 143 144 /** 145 * Returns the number of rows matching the dynamic query. 146 * 147 * @param dynamicQuery the dynamic query 148 * @return the number of rows matching the dynamic query 149 */ 150 public long dynamicQueryCount( 151 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 152 153 /** 154 * Returns the number of rows matching the dynamic query. 155 * 156 * @param dynamicQuery the dynamic query 157 * @param projection the projection to apply to the query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 162 com.liferay.portal.kernel.dao.orm.Projection projection); 163 164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 165 public com.liferay.counter.model.Counter fetchCounter(java.lang.String name); 166 167 /** 168 * Returns the counter with the primary key. 169 * 170 * @param name the primary key of the counter 171 * @return the counter 172 * @throws PortalException if a counter with the primary key could not be found 173 */ 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.counter.model.Counter getCounter(java.lang.String name) 176 throws PortalException; 177 178 /** 179 * Returns a range of all the counters. 180 * 181 * <p> 182 * 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. 183 * </p> 184 * 185 * @param start the lower bound of the range of counters 186 * @param end the upper bound of the range of counters (not inclusive) 187 * @return the range of counters 188 */ 189 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 190 public java.util.List<com.liferay.counter.model.Counter> getCounters( 191 int start, int end); 192 193 /** 194 * Returns the number of counters. 195 * 196 * @return the number of counters 197 */ 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public int getCountersCount(); 200 201 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 202 public java.util.List<java.lang.String> getNames(); 203 204 /** 205 * Returns the OSGi service identifier. 206 * 207 * @return the OSGi service identifier 208 */ 209 public java.lang.String getOSGiServiceIdentifier(); 210 211 @Override 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public com.liferay.portal.model.PersistedModel getPersistedModel( 214 java.io.Serializable primaryKeyObj) throws PortalException; 215 216 @Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 217 public long increment(); 218 219 @Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 220 public long increment(java.lang.String name); 221 222 @Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 223 public long increment(java.lang.String name, int size); 224 225 @Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 226 public void rename(java.lang.String oldName, java.lang.String newName); 227 228 @Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 229 public void reset(java.lang.String name); 230 231 @Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 232 public void reset(java.lang.String name, long size); 233 234 /** 235 * Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 236 * 237 * @param counter the counter 238 * @return the counter that was updated 239 */ 240 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 241 public com.liferay.counter.model.Counter updateCounter( 242 com.liferay.counter.model.Counter counter); 243 }