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