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