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