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