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