001    /**
002     * Copyright (c) 2000-2012 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.SocialActivitySet;
020    
021    /**
022     * The persistence interface for the social activity set service.
023     *
024     * <p>
025     * Caching information and settings can be found in <code>portal.properties</code>
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see SocialActivitySetPersistenceImpl
030     * @see SocialActivitySetUtil
031     * @generated
032     */
033    public interface SocialActivitySetPersistence extends BasePersistence<SocialActivitySet> {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify or reference this interface directly. Always use {@link SocialActivitySetUtil} to access the social activity set persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
038             */
039    
040            /**
041            * Caches the social activity set in the entity cache if it is enabled.
042            *
043            * @param socialActivitySet the social activity set
044            */
045            public void cacheResult(
046                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
047    
048            /**
049            * Caches the social activity sets in the entity cache if it is enabled.
050            *
051            * @param socialActivitySets the social activity sets
052            */
053            public void cacheResult(
054                    java.util.List<com.liferay.portlet.social.model.SocialActivitySet> socialActivitySets);
055    
056            /**
057            * Creates a new social activity set with the primary key. Does not add the social activity set to the database.
058            *
059            * @param activitySetId the primary key for the new social activity set
060            * @return the new social activity set
061            */
062            public com.liferay.portlet.social.model.SocialActivitySet create(
063                    long activitySetId);
064    
065            /**
066            * Removes the social activity set with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param activitySetId the primary key of the social activity set
069            * @return the social activity set that was removed
070            * @throws com.liferay.portlet.social.NoSuchActivitySetException if a social activity set with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public com.liferay.portlet.social.model.SocialActivitySet remove(
074                    long activitySetId)
075                    throws com.liferay.portal.kernel.exception.SystemException,
076                            com.liferay.portlet.social.NoSuchActivitySetException;
077    
078            public com.liferay.portlet.social.model.SocialActivitySet updateImpl(
079                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet)
080                    throws com.liferay.portal.kernel.exception.SystemException;
081    
082            /**
083            * Returns the social activity set with the primary key or throws a {@link com.liferay.portlet.social.NoSuchActivitySetException} if it could not be found.
084            *
085            * @param activitySetId the primary key of the social activity set
086            * @return the social activity set
087            * @throws com.liferay.portlet.social.NoSuchActivitySetException if a social activity set with the primary key could not be found
088            * @throws SystemException if a system exception occurred
089            */
090            public com.liferay.portlet.social.model.SocialActivitySet findByPrimaryKey(
091                    long activitySetId)
092                    throws com.liferay.portal.kernel.exception.SystemException,
093                            com.liferay.portlet.social.NoSuchActivitySetException;
094    
095            /**
096            * Returns the social activity set with the primary key or returns <code>null</code> if it could not be found.
097            *
098            * @param activitySetId the primary key of the social activity set
099            * @return the social activity set, or <code>null</code> if a social activity set with the primary key could not be found
100            * @throws SystemException if a system exception occurred
101            */
102            public com.liferay.portlet.social.model.SocialActivitySet fetchByPrimaryKey(
103                    long activitySetId)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Returns all the social activity sets.
108            *
109            * @return the social activity sets
110            * @throws SystemException if a system exception occurred
111            */
112            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> findAll()
113                    throws com.liferay.portal.kernel.exception.SystemException;
114    
115            /**
116            * Returns a range of all the social activity sets.
117            *
118            * <p>
119            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySetModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
120            * </p>
121            *
122            * @param start the lower bound of the range of social activity sets
123            * @param end the upper bound of the range of social activity sets (not inclusive)
124            * @return the range of social activity sets
125            * @throws SystemException if a system exception occurred
126            */
127            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> findAll(
128                    int start, int end)
129                    throws com.liferay.portal.kernel.exception.SystemException;
130    
131            /**
132            * Returns an ordered range of all the social activity sets.
133            *
134            * <p>
135            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivitySetModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
136            * </p>
137            *
138            * @param start the lower bound of the range of social activity sets
139            * @param end the upper bound of the range of social activity sets (not inclusive)
140            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
141            * @return the ordered range of social activity sets
142            * @throws SystemException if a system exception occurred
143            */
144            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> findAll(
145                    int start, int end,
146                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Removes all the social activity sets from the database.
151            *
152            * @throws SystemException if a system exception occurred
153            */
154            public void removeAll()
155                    throws com.liferay.portal.kernel.exception.SystemException;
156    
157            /**
158            * Returns the number of social activity sets.
159            *
160            * @return the number of social activity sets
161            * @throws SystemException if a system exception occurred
162            */
163            public int countAll()
164                    throws com.liferay.portal.kernel.exception.SystemException;
165    }