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.portlet.social.service.persistence; 016 017 import com.liferay.portal.service.persistence.BasePersistence; 018 019 import com.liferay.portlet.social.model.SocialEquityHistory; 020 021 /** 022 * The persistence interface for the social equity history service. 023 * 024 * <p> 025 * Never modify or reference this interface directly. Always use {@link SocialEquityHistoryUtil} to access the social equity history 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 SocialEquityHistoryPersistenceImpl 034 * @see SocialEquityHistoryUtil 035 * @generated 036 */ 037 public interface SocialEquityHistoryPersistence extends BasePersistence<SocialEquityHistory> { 038 /** 039 * Caches the social equity history in the entity cache if it is enabled. 040 * 041 * @param socialEquityHistory the social equity history to cache 042 */ 043 public void cacheResult( 044 com.liferay.portlet.social.model.SocialEquityHistory socialEquityHistory); 045 046 /** 047 * Caches the social equity histories in the entity cache if it is enabled. 048 * 049 * @param socialEquityHistories the social equity histories to cache 050 */ 051 public void cacheResult( 052 java.util.List<com.liferay.portlet.social.model.SocialEquityHistory> socialEquityHistories); 053 054 /** 055 * Creates a new social equity history with the primary key. Does not add the social equity history to the database. 056 * 057 * @param equityHistoryId the primary key for the new social equity history 058 * @return the new social equity history 059 */ 060 public com.liferay.portlet.social.model.SocialEquityHistory create( 061 long equityHistoryId); 062 063 /** 064 * Removes the social equity history with the primary key from the database. Also notifies the appropriate model listeners. 065 * 066 * @param equityHistoryId the primary key of the social equity history to remove 067 * @return the social equity history that was removed 068 * @throws com.liferay.portlet.social.NoSuchEquityHistoryException if a social equity history with the primary key could not be found 069 * @throws SystemException if a system exception occurred 070 */ 071 public com.liferay.portlet.social.model.SocialEquityHistory remove( 072 long equityHistoryId) 073 throws com.liferay.portal.kernel.exception.SystemException, 074 com.liferay.portlet.social.NoSuchEquityHistoryException; 075 076 public com.liferay.portlet.social.model.SocialEquityHistory updateImpl( 077 com.liferay.portlet.social.model.SocialEquityHistory socialEquityHistory, 078 boolean merge) 079 throws com.liferay.portal.kernel.exception.SystemException; 080 081 /** 082 * Finds the social equity history with the primary key or throws a {@link com.liferay.portlet.social.NoSuchEquityHistoryException} if it could not be found. 083 * 084 * @param equityHistoryId the primary key of the social equity history to find 085 * @return the social equity history 086 * @throws com.liferay.portlet.social.NoSuchEquityHistoryException if a social equity history with the primary key could not be found 087 * @throws SystemException if a system exception occurred 088 */ 089 public com.liferay.portlet.social.model.SocialEquityHistory findByPrimaryKey( 090 long equityHistoryId) 091 throws com.liferay.portal.kernel.exception.SystemException, 092 com.liferay.portlet.social.NoSuchEquityHistoryException; 093 094 /** 095 * Finds the social equity history with the primary key or returns <code>null</code> if it could not be found. 096 * 097 * @param equityHistoryId the primary key of the social equity history to find 098 * @return the social equity history, or <code>null</code> if a social equity history with the primary key could not be found 099 * @throws SystemException if a system exception occurred 100 */ 101 public com.liferay.portlet.social.model.SocialEquityHistory fetchByPrimaryKey( 102 long equityHistoryId) 103 throws com.liferay.portal.kernel.exception.SystemException; 104 105 /** 106 * Finds all the social equity histories. 107 * 108 * @return the social equity histories 109 * @throws SystemException if a system exception occurred 110 */ 111 public java.util.List<com.liferay.portlet.social.model.SocialEquityHistory> findAll() 112 throws com.liferay.portal.kernel.exception.SystemException; 113 114 /** 115 * Finds a range of all the social equity histories. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param start the lower bound of the range of social equity histories to return 122 * @param end the upper bound of the range of social equity histories to return (not inclusive) 123 * @return the range of social equity histories 124 * @throws SystemException if a system exception occurred 125 */ 126 public java.util.List<com.liferay.portlet.social.model.SocialEquityHistory> findAll( 127 int start, int end) 128 throws com.liferay.portal.kernel.exception.SystemException; 129 130 /** 131 * Finds an ordered range of all the social equity histories. 132 * 133 * <p> 134 * 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. 135 * </p> 136 * 137 * @param start the lower bound of the range of social equity histories to return 138 * @param end the upper bound of the range of social equity histories to return (not inclusive) 139 * @param orderByComparator the comparator to order the results by 140 * @return the ordered range of social equity histories 141 * @throws SystemException if a system exception occurred 142 */ 143 public java.util.List<com.liferay.portlet.social.model.SocialEquityHistory> findAll( 144 int start, int end, 145 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 146 throws com.liferay.portal.kernel.exception.SystemException; 147 148 /** 149 * Removes all the social equity histories from the database. 150 * 151 * @throws SystemException if a system exception occurred 152 */ 153 public void removeAll() 154 throws com.liferay.portal.kernel.exception.SystemException; 155 156 /** 157 * Counts all the social equity histories. 158 * 159 * @return the number of social equity histories 160 * @throws SystemException if a system exception occurred 161 */ 162 public int countAll() 163 throws com.liferay.portal.kernel.exception.SystemException; 164 }