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.SocialEquityAssetEntry; 021 022 /** 023 * The persistence interface for the social equity asset entry 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 SocialEquityAssetEntryPersistenceImpl 031 * @see SocialEquityAssetEntryUtil 032 * @generated 033 */ 034 public interface SocialEquityAssetEntryPersistence extends BasePersistence<SocialEquityAssetEntry> { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify or reference this interface directly. Always use {@link SocialEquityAssetEntryUtil} to access the social equity asset entry persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface. 039 */ 040 041 /** 042 * Caches the social equity asset entry in the entity cache if it is enabled. 043 * 044 * @param socialEquityAssetEntry the social equity asset entry 045 */ 046 public void cacheResult( 047 com.liferay.portlet.social.model.SocialEquityAssetEntry socialEquityAssetEntry); 048 049 /** 050 * Caches the social equity asset entries in the entity cache if it is enabled. 051 * 052 * @param socialEquityAssetEntries the social equity asset entries 053 */ 054 public void cacheResult( 055 java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> socialEquityAssetEntries); 056 057 /** 058 * Creates a new social equity asset entry with the primary key. Does not add the social equity asset entry to the database. 059 * 060 * @param equityAssetEntryId the primary key for the new social equity asset entry 061 * @return the new social equity asset entry 062 */ 063 public com.liferay.portlet.social.model.SocialEquityAssetEntry create( 064 long equityAssetEntryId); 065 066 /** 067 * Removes the social equity asset entry with the primary key from the database. Also notifies the appropriate model listeners. 068 * 069 * @param equityAssetEntryId the primary key of the social equity asset entry 070 * @return the social equity asset entry that was removed 071 * @throws com.liferay.portlet.social.NoSuchEquityAssetEntryException if a social equity asset entry with the primary key could not be found 072 * @throws SystemException if a system exception occurred 073 */ 074 public com.liferay.portlet.social.model.SocialEquityAssetEntry remove( 075 long equityAssetEntryId) 076 throws com.liferay.portal.kernel.exception.SystemException, 077 com.liferay.portlet.social.NoSuchEquityAssetEntryException; 078 079 public com.liferay.portlet.social.model.SocialEquityAssetEntry updateImpl( 080 com.liferay.portlet.social.model.SocialEquityAssetEntry socialEquityAssetEntry, 081 boolean merge) 082 throws com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Returns the social equity asset entry with the primary key or throws a {@link com.liferay.portlet.social.NoSuchEquityAssetEntryException} if it could not be found. 086 * 087 * @param equityAssetEntryId the primary key of the social equity asset entry 088 * @return the social equity asset entry 089 * @throws com.liferay.portlet.social.NoSuchEquityAssetEntryException if a social equity asset entry with the primary key could not be found 090 * @throws SystemException if a system exception occurred 091 */ 092 public com.liferay.portlet.social.model.SocialEquityAssetEntry findByPrimaryKey( 093 long equityAssetEntryId) 094 throws com.liferay.portal.kernel.exception.SystemException, 095 com.liferay.portlet.social.NoSuchEquityAssetEntryException; 096 097 /** 098 * Returns the social equity asset entry with the primary key or returns <code>null</code> if it could not be found. 099 * 100 * @param equityAssetEntryId the primary key of the social equity asset entry 101 * @return the social equity asset entry, or <code>null</code> if a social equity asset entry with the primary key could not be found 102 * @throws SystemException if a system exception occurred 103 */ 104 public com.liferay.portlet.social.model.SocialEquityAssetEntry fetchByPrimaryKey( 105 long equityAssetEntryId) 106 throws com.liferay.portal.kernel.exception.SystemException; 107 108 /** 109 * Returns the social equity asset entry where assetEntryId = ? or throws a {@link com.liferay.portlet.social.NoSuchEquityAssetEntryException} if it could not be found. 110 * 111 * @param assetEntryId the asset entry ID 112 * @return the matching social equity asset entry 113 * @throws com.liferay.portlet.social.NoSuchEquityAssetEntryException if a matching social equity asset entry could not be found 114 * @throws SystemException if a system exception occurred 115 */ 116 public com.liferay.portlet.social.model.SocialEquityAssetEntry findByAssetEntryId( 117 long assetEntryId) 118 throws com.liferay.portal.kernel.exception.SystemException, 119 com.liferay.portlet.social.NoSuchEquityAssetEntryException; 120 121 /** 122 * Returns the social equity asset entry where assetEntryId = ? or returns <code>null</code> if it could not be found. Uses the finder cache. 123 * 124 * @param assetEntryId the asset entry ID 125 * @return the matching social equity asset entry, or <code>null</code> if a matching social equity asset entry could not be found 126 * @throws SystemException if a system exception occurred 127 */ 128 public com.liferay.portlet.social.model.SocialEquityAssetEntry fetchByAssetEntryId( 129 long assetEntryId) 130 throws com.liferay.portal.kernel.exception.SystemException; 131 132 /** 133 * Returns the social equity asset entry where assetEntryId = ? or returns <code>null</code> if it could not be found, optionally using the finder cache. 134 * 135 * @param assetEntryId the asset entry ID 136 * @param retrieveFromCache whether to use the finder cache 137 * @return the matching social equity asset entry, or <code>null</code> if a matching social equity asset entry could not be found 138 * @throws SystemException if a system exception occurred 139 */ 140 public com.liferay.portlet.social.model.SocialEquityAssetEntry fetchByAssetEntryId( 141 long assetEntryId, boolean retrieveFromCache) 142 throws com.liferay.portal.kernel.exception.SystemException; 143 144 /** 145 * Returns all the social equity asset entries. 146 * 147 * @return the social equity asset entries 148 * @throws SystemException if a system exception occurred 149 */ 150 public java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> findAll() 151 throws com.liferay.portal.kernel.exception.SystemException; 152 153 /** 154 * Returns a range of all the social equity asset entries. 155 * 156 * <p> 157 * 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. 158 * </p> 159 * 160 * @param start the lower bound of the range of social equity asset entries 161 * @param end the upper bound of the range of social equity asset entries (not inclusive) 162 * @return the range of social equity asset entries 163 * @throws SystemException if a system exception occurred 164 */ 165 public java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> findAll( 166 int start, int end) 167 throws com.liferay.portal.kernel.exception.SystemException; 168 169 /** 170 * Returns an ordered range of all the social equity asset entries. 171 * 172 * <p> 173 * 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. 174 * </p> 175 * 176 * @param start the lower bound of the range of social equity asset entries 177 * @param end the upper bound of the range of social equity asset entries (not inclusive) 178 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 179 * @return the ordered range of social equity asset entries 180 * @throws SystemException if a system exception occurred 181 */ 182 public java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> findAll( 183 int start, int end, 184 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Removes the social equity asset entry where assetEntryId = ? from the database. 189 * 190 * @param assetEntryId the asset entry ID 191 * @throws SystemException if a system exception occurred 192 */ 193 public void removeByAssetEntryId(long assetEntryId) 194 throws com.liferay.portal.kernel.exception.SystemException, 195 com.liferay.portlet.social.NoSuchEquityAssetEntryException; 196 197 /** 198 * Removes all the social equity asset entries from the database. 199 * 200 * @throws SystemException if a system exception occurred 201 */ 202 public void removeAll() 203 throws com.liferay.portal.kernel.exception.SystemException; 204 205 /** 206 * Returns the number of social equity asset entries where assetEntryId = ?. 207 * 208 * @param assetEntryId the asset entry ID 209 * @return the number of matching social equity asset entries 210 * @throws SystemException if a system exception occurred 211 */ 212 public int countByAssetEntryId(long assetEntryId) 213 throws com.liferay.portal.kernel.exception.SystemException; 214 215 /** 216 * Returns the number of social equity asset entries. 217 * 218 * @return the number of social equity asset entries 219 * @throws SystemException if a system exception occurred 220 */ 221 public int countAll() 222 throws com.liferay.portal.kernel.exception.SystemException; 223 224 public SocialEquityAssetEntry remove( 225 SocialEquityAssetEntry socialEquityAssetEntry) 226 throws SystemException; 227 }