001 /** 002 * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved. 003 * 004 * The contents of this file are subject to the terms of the Liferay Enterprise 005 * Subscription License ("License"). You may not use this file except in 006 * compliance with the License. You can obtain a copy of the License by 007 * contacting Liferay, Inc. See the License for the specific language governing 008 * permissions and limitations under the License, including but not limited to 009 * distribution rights of the Software. 010 * 011 * 012 * 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 to cache 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 to cache 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 to remove 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 * Finds 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 to find 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 * Finds 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 to find 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 * Finds 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 to search with 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 * Finds 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 to search with 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 * Finds 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 to search with 136 * @return the matching social equity asset entry, or <code>null</code> if a matching social equity asset entry could not be found 137 * @throws SystemException if a system exception occurred 138 */ 139 public com.liferay.portlet.social.model.SocialEquityAssetEntry fetchByAssetEntryId( 140 long assetEntryId, boolean retrieveFromCache) 141 throws com.liferay.portal.kernel.exception.SystemException; 142 143 /** 144 * Finds all the social equity asset entries. 145 * 146 * @return the social equity asset entries 147 * @throws SystemException if a system exception occurred 148 */ 149 public java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> findAll() 150 throws com.liferay.portal.kernel.exception.SystemException; 151 152 /** 153 * Finds a range of all the social equity asset entries. 154 * 155 * <p> 156 * 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. 157 * </p> 158 * 159 * @param start the lower bound of the range of social equity asset entries to return 160 * @param end the upper bound of the range of social equity asset entries to return (not inclusive) 161 * @return the range of social equity asset entries 162 * @throws SystemException if a system exception occurred 163 */ 164 public java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> findAll( 165 int start, int end) 166 throws com.liferay.portal.kernel.exception.SystemException; 167 168 /** 169 * Finds an ordered range of all the social equity asset entries. 170 * 171 * <p> 172 * 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. 173 * </p> 174 * 175 * @param start the lower bound of the range of social equity asset entries to return 176 * @param end the upper bound of the range of social equity asset entries to return (not inclusive) 177 * @param orderByComparator the comparator to order the results by 178 * @return the ordered range of social equity asset entries 179 * @throws SystemException if a system exception occurred 180 */ 181 public java.util.List<com.liferay.portlet.social.model.SocialEquityAssetEntry> findAll( 182 int start, int end, 183 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 184 throws com.liferay.portal.kernel.exception.SystemException; 185 186 /** 187 * Removes the social equity asset entry where assetEntryId = ? from the database. 188 * 189 * @param assetEntryId the asset entry ID to search with 190 * @throws SystemException if a system exception occurred 191 */ 192 public void removeByAssetEntryId(long assetEntryId) 193 throws com.liferay.portal.kernel.exception.SystemException, 194 com.liferay.portlet.social.NoSuchEquityAssetEntryException; 195 196 /** 197 * Removes all the social equity asset entries from the database. 198 * 199 * @throws SystemException if a system exception occurred 200 */ 201 public void removeAll() 202 throws com.liferay.portal.kernel.exception.SystemException; 203 204 /** 205 * Counts all the social equity asset entries where assetEntryId = ?. 206 * 207 * @param assetEntryId the asset entry ID to search with 208 * @return the number of matching social equity asset entries 209 * @throws SystemException if a system exception occurred 210 */ 211 public int countByAssetEntryId(long assetEntryId) 212 throws com.liferay.portal.kernel.exception.SystemException; 213 214 /** 215 * Counts all the social equity asset entries. 216 * 217 * @return the number of social equity asset entries 218 * @throws SystemException if a system exception occurred 219 */ 220 public int countAll() 221 throws com.liferay.portal.kernel.exception.SystemException; 222 223 public SocialEquityAssetEntry remove( 224 SocialEquityAssetEntry socialEquityAssetEntry) 225 throws SystemException; 226 }