001 /** 002 * Copyright (c) 2000-2011 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 /** 149 * Returns the counter with the primary key. 150 * 151 * @param name the primary key of the counter 152 * @return the counter 153 * @throws PortalException if a counter with the primary key could not be found 154 * @throws SystemException if a system exception occurred 155 */ 156 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 157 public com.liferay.counter.model.Counter getCounter(java.lang.String name) 158 throws com.liferay.portal.kernel.exception.PortalException, 159 com.liferay.portal.kernel.exception.SystemException; 160 161 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 162 public com.liferay.portal.model.PersistedModel getPersistedModel( 163 java.io.Serializable primaryKeyObj) 164 throws com.liferay.portal.kernel.exception.PortalException, 165 com.liferay.portal.kernel.exception.SystemException; 166 167 /** 168 * Returns a range of all the counters. 169 * 170 * <p> 171 * 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. 172 * </p> 173 * 174 * @param start the lower bound of the range of counters 175 * @param end the upper bound of the range of counters (not inclusive) 176 * @return the range of counters 177 * @throws SystemException if a system exception occurred 178 */ 179 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 180 public java.util.List<com.liferay.counter.model.Counter> getCounters( 181 int start, int end) 182 throws com.liferay.portal.kernel.exception.SystemException; 183 184 /** 185 * Returns the number of counters. 186 * 187 * @return the number of counters 188 * @throws SystemException if a system exception occurred 189 */ 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public int getCountersCount() 192 throws com.liferay.portal.kernel.exception.SystemException; 193 194 /** 195 * Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 196 * 197 * @param counter the counter 198 * @return the counter that was updated 199 * @throws SystemException if a system exception occurred 200 */ 201 public com.liferay.counter.model.Counter updateCounter( 202 com.liferay.counter.model.Counter counter) 203 throws com.liferay.portal.kernel.exception.SystemException; 204 205 /** 206 * Updates the counter in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 207 * 208 * @param counter the counter 209 * @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. 210 * @return the counter that was updated 211 * @throws SystemException if a system exception occurred 212 */ 213 public com.liferay.counter.model.Counter updateCounter( 214 com.liferay.counter.model.Counter counter, boolean merge) 215 throws com.liferay.portal.kernel.exception.SystemException; 216 217 /** 218 * Returns the Spring bean ID for this bean. 219 * 220 * @return the Spring bean ID for this bean 221 */ 222 public java.lang.String getBeanIdentifier(); 223 224 /** 225 * Sets the Spring bean ID for this bean. 226 * 227 * @param beanIdentifier the Spring bean ID for this bean 228 */ 229 public void setBeanIdentifier(java.lang.String beanIdentifier); 230 231 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 232 public java.util.List<java.lang.String> getNames() 233 throws com.liferay.portal.kernel.exception.SystemException; 234 235 public long increment() 236 throws com.liferay.portal.kernel.exception.SystemException; 237 238 public long increment(java.lang.String name) 239 throws com.liferay.portal.kernel.exception.SystemException; 240 241 public long increment(java.lang.String name, int size) 242 throws com.liferay.portal.kernel.exception.SystemException; 243 244 public void rename(java.lang.String oldName, java.lang.String newName) 245 throws com.liferay.portal.kernel.exception.SystemException; 246 247 public void reset(java.lang.String name) 248 throws com.liferay.portal.kernel.exception.SystemException; 249 250 public void reset(java.lang.String name, long size) 251 throws com.liferay.portal.kernel.exception.SystemException; 252 }