001 /** 002 * Copyright (c) 2000-2010 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.persistence; 016 017 import com.liferay.counter.model.Counter; 018 019 import com.liferay.portal.service.persistence.BasePersistence; 020 021 /** 022 * The persistence interface for the counter service. 023 * 024 * <p> 025 * Never modify or reference this interface directly. Always use {@link CounterUtil} to access the counter persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 026 * </p> 027 * 028 * <p> 029 * Caching information and settings can be found in <code>portal.properties</code> 030 * </p> 031 * 032 * @author Brian Wing Shun Chan 033 * @see CounterPersistenceImpl 034 * @see CounterUtil 035 * @generated 036 */ 037 public interface CounterPersistence extends BasePersistence<Counter> { 038 /** 039 * Caches the counter in the entity cache if it is enabled. 040 * 041 * @param counter the counter to cache 042 */ 043 public void cacheResult(com.liferay.counter.model.Counter counter); 044 045 /** 046 * Caches the counters in the entity cache if it is enabled. 047 * 048 * @param counters the counters to cache 049 */ 050 public void cacheResult( 051 java.util.List<com.liferay.counter.model.Counter> counters); 052 053 /** 054 * Creates a new counter with the primary key. Does not add the counter to the database. 055 * 056 * @param name the primary key for the new counter 057 * @return the new counter 058 */ 059 public com.liferay.counter.model.Counter create(java.lang.String name); 060 061 /** 062 * Removes the counter with the primary key from the database. Also notifies the appropriate model listeners. 063 * 064 * @param name the primary key of the counter to remove 065 * @return the counter that was removed 066 * @throws com.liferay.counter.NoSuchCounterException if a counter with the primary key could not be found 067 * @throws SystemException if a system exception occurred 068 */ 069 public com.liferay.counter.model.Counter remove(java.lang.String name) 070 throws com.liferay.counter.NoSuchCounterException, 071 com.liferay.portal.kernel.exception.SystemException; 072 073 public com.liferay.counter.model.Counter updateImpl( 074 com.liferay.counter.model.Counter counter, boolean merge) 075 throws com.liferay.portal.kernel.exception.SystemException; 076 077 /** 078 * Finds the counter with the primary key or throws a {@link com.liferay.counter.NoSuchCounterException} if it could not be found. 079 * 080 * @param name the primary key of the counter to find 081 * @return the counter 082 * @throws com.liferay.counter.NoSuchCounterException if a counter with the primary key could not be found 083 * @throws SystemException if a system exception occurred 084 */ 085 public com.liferay.counter.model.Counter findByPrimaryKey( 086 java.lang.String name) 087 throws com.liferay.counter.NoSuchCounterException, 088 com.liferay.portal.kernel.exception.SystemException; 089 090 /** 091 * Finds the counter with the primary key or returns <code>null</code> if it could not be found. 092 * 093 * @param name the primary key of the counter to find 094 * @return the counter, or <code>null</code> if a counter with the primary key could not be found 095 * @throws SystemException if a system exception occurred 096 */ 097 public com.liferay.counter.model.Counter fetchByPrimaryKey( 098 java.lang.String name) 099 throws com.liferay.portal.kernel.exception.SystemException; 100 101 /** 102 * Finds all the counters. 103 * 104 * @return the counters 105 * @throws SystemException if a system exception occurred 106 */ 107 public java.util.List<com.liferay.counter.model.Counter> findAll() 108 throws com.liferay.portal.kernel.exception.SystemException; 109 110 /** 111 * Finds a range of all the counters. 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. 115 * </p> 116 * 117 * @param start the lower bound of the range of counters to return 118 * @param end the upper bound of the range of counters to return (not inclusive) 119 * @return the range of counters 120 * @throws SystemException if a system exception occurred 121 */ 122 public java.util.List<com.liferay.counter.model.Counter> findAll( 123 int start, int end) 124 throws com.liferay.portal.kernel.exception.SystemException; 125 126 /** 127 * Finds an ordered range of all the counters. 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. 131 * </p> 132 * 133 * @param start the lower bound of the range of counters to return 134 * @param end the upper bound of the range of counters to return (not inclusive) 135 * @param orderByComparator the comparator to order the results by 136 * @return the ordered range of counters 137 * @throws SystemException if a system exception occurred 138 */ 139 public java.util.List<com.liferay.counter.model.Counter> findAll( 140 int start, int end, 141 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Removes all the counters from the database. 146 * 147 * @throws SystemException if a system exception occurred 148 */ 149 public void removeAll() 150 throws com.liferay.portal.kernel.exception.SystemException; 151 152 /** 153 * Counts all the counters. 154 * 155 * @return the number of counters 156 * @throws SystemException if a system exception occurred 157 */ 158 public int countAll() 159 throws com.liferay.portal.kernel.exception.SystemException; 160 }