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) 090 throws com.liferay.portal.kernel.exception.PortalException; 091 092 /** 093 * @throws PortalException 094 */ 095 @Override 096 public com.liferay.portal.model.PersistedModel deletePersistedModel( 097 com.liferay.portal.model.PersistedModel persistedModel) 098 throws com.liferay.portal.kernel.exception.PortalException; 099 100 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 101 102 /** 103 * Performs a dynamic query on the database and returns the matching rows. 104 * 105 * @param dynamicQuery the dynamic query 106 * @return the matching rows 107 */ 108 public <T> java.util.List<T> dynamicQuery( 109 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 110 111 /** 112 * Performs a dynamic query on the database and returns a range of the matching rows. 113 * 114 * <p> 115 * 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. 116 * </p> 117 * 118 * @param dynamicQuery the dynamic query 119 * @param start the lower bound of the range of model instances 120 * @param end the upper bound of the range of model instances (not inclusive) 121 * @return the range of matching rows 122 */ 123 public <T> java.util.List<T> dynamicQuery( 124 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 125 int end); 126 127 /** 128 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 129 * 130 * <p> 131 * 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. 132 * </p> 133 * 134 * @param dynamicQuery the dynamic query 135 * @param start the lower bound of the range of model instances 136 * @param end the upper bound of the range of model instances (not inclusive) 137 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 138 * @return the ordered range of matching rows 139 */ 140 public <T> java.util.List<T> dynamicQuery( 141 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 142 int end, 143 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 144 145 /** 146 * Returns the number of rows matching the dynamic query. 147 * 148 * @param dynamicQuery the dynamic query 149 * @return the number of rows matching the dynamic query 150 */ 151 public long dynamicQueryCount( 152 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 153 154 /** 155 * Returns the number of rows matching the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @param projection the projection to apply to the query 159 * @return the number of rows matching the dynamic query 160 */ 161 public long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 163 com.liferay.portal.kernel.dao.orm.Projection projection); 164 165 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 166 public com.liferay.counter.model.Counter fetchCounter(java.lang.String name); 167 168 /** 169 * Returns the Spring bean ID for this bean. 170 * 171 * @return the Spring bean ID for this bean 172 */ 173 public java.lang.String getBeanIdentifier(); 174 175 /** 176 * Returns the counter with the primary key. 177 * 178 * @param name the primary key of the counter 179 * @return the counter 180 * @throws PortalException if a counter with the primary key could not be found 181 */ 182 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 183 public com.liferay.counter.model.Counter getCounter(java.lang.String name) 184 throws com.liferay.portal.kernel.exception.PortalException; 185 186 /** 187 * Returns a range of all the counters. 188 * 189 * <p> 190 * 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. 191 * </p> 192 * 193 * @param start the lower bound of the range of counters 194 * @param end the upper bound of the range of counters (not inclusive) 195 * @return the range of counters 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public java.util.List<com.liferay.counter.model.Counter> getCounters( 199 int start, int end); 200 201 /** 202 * Returns the number of counters. 203 * 204 * @return the number of counters 205 */ 206 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 207 public int getCountersCount(); 208 209 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 210 public java.util.List<java.lang.String> getNames(); 211 212 @Override 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public com.liferay.portal.model.PersistedModel getPersistedModel( 215 java.io.Serializable primaryKeyObj) 216 throws com.liferay.portal.kernel.exception.PortalException; 217 218 @com.liferay.portal.kernel.transaction.Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 219 public long increment(); 220 221 @com.liferay.portal.kernel.transaction.Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 222 public long increment(java.lang.String name); 223 224 @com.liferay.portal.kernel.transaction.Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 225 public long increment(java.lang.String name, int size); 226 227 @com.liferay.portal.kernel.transaction.Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 228 public void rename(java.lang.String oldName, java.lang.String newName); 229 230 @com.liferay.portal.kernel.transaction.Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 231 public void reset(java.lang.String name); 232 233 @com.liferay.portal.kernel.transaction.Transactional(isolation = Isolation.COUNTER, propagation = Propagation.REQUIRES_NEW) 234 public void reset(java.lang.String name, long size); 235 236 /** 237 * Sets the Spring bean ID for this bean. 238 * 239 * @param beanIdentifier the Spring bean ID for this bean 240 */ 241 public void setBeanIdentifier(java.lang.String beanIdentifier); 242 243 /** 244 * Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 245 * 246 * @param counter the counter 247 * @return the counter that was updated 248 */ 249 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 250 public com.liferay.counter.model.Counter updateCounter( 251 com.liferay.counter.model.Counter counter); 252 }