001    /**
002     * Copyright (c) 2000-present 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.portal.service.persistence;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.model.ClusterGroup;
020    
021    /**
022     * The persistence interface for the cluster group 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 ClusterGroupPersistenceImpl
030     * @see ClusterGroupUtil
031     * @generated
032     */
033    @ProviderType
034    public interface ClusterGroupPersistence extends BasePersistence<ClusterGroup> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link ClusterGroupUtil} to access the cluster group persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Caches the cluster group in the entity cache if it is enabled.
043            *
044            * @param clusterGroup the cluster group
045            */
046            public void cacheResult(com.liferay.portal.model.ClusterGroup clusterGroup);
047    
048            /**
049            * Caches the cluster groups in the entity cache if it is enabled.
050            *
051            * @param clusterGroups the cluster groups
052            */
053            public void cacheResult(
054                    java.util.List<com.liferay.portal.model.ClusterGroup> clusterGroups);
055    
056            /**
057            * Creates a new cluster group with the primary key. Does not add the cluster group to the database.
058            *
059            * @param clusterGroupId the primary key for the new cluster group
060            * @return the new cluster group
061            */
062            public com.liferay.portal.model.ClusterGroup create(long clusterGroupId);
063    
064            /**
065            * Removes the cluster group with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param clusterGroupId the primary key of the cluster group
068            * @return the cluster group that was removed
069            * @throws com.liferay.portal.NoSuchClusterGroupException if a cluster group with the primary key could not be found
070            */
071            public com.liferay.portal.model.ClusterGroup remove(long clusterGroupId)
072                    throws com.liferay.portal.NoSuchClusterGroupException;
073    
074            public com.liferay.portal.model.ClusterGroup updateImpl(
075                    com.liferay.portal.model.ClusterGroup clusterGroup);
076    
077            /**
078            * Returns the cluster group with the primary key or throws a {@link com.liferay.portal.NoSuchClusterGroupException} if it could not be found.
079            *
080            * @param clusterGroupId the primary key of the cluster group
081            * @return the cluster group
082            * @throws com.liferay.portal.NoSuchClusterGroupException if a cluster group with the primary key could not be found
083            */
084            public com.liferay.portal.model.ClusterGroup findByPrimaryKey(
085                    long clusterGroupId)
086                    throws com.liferay.portal.NoSuchClusterGroupException;
087    
088            /**
089            * Returns the cluster group with the primary key or returns <code>null</code> if it could not be found.
090            *
091            * @param clusterGroupId the primary key of the cluster group
092            * @return the cluster group, or <code>null</code> if a cluster group with the primary key could not be found
093            */
094            public com.liferay.portal.model.ClusterGroup fetchByPrimaryKey(
095                    long clusterGroupId);
096    
097            @Override
098            public java.util.Map<java.io.Serializable, com.liferay.portal.model.ClusterGroup> fetchByPrimaryKeys(
099                    java.util.Set<java.io.Serializable> primaryKeys);
100    
101            /**
102            * Returns all the cluster groups.
103            *
104            * @return the cluster groups
105            */
106            public java.util.List<com.liferay.portal.model.ClusterGroup> findAll();
107    
108            /**
109            * Returns a range of all the cluster groups.
110            *
111            * <p>
112            * 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.portal.model.impl.ClusterGroupModelImpl}. 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.
113            * </p>
114            *
115            * @param start the lower bound of the range of cluster groups
116            * @param end the upper bound of the range of cluster groups (not inclusive)
117            * @return the range of cluster groups
118            */
119            public java.util.List<com.liferay.portal.model.ClusterGroup> findAll(
120                    int start, int end);
121    
122            /**
123            * Returns an ordered range of all the cluster groups.
124            *
125            * <p>
126            * 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.portal.model.impl.ClusterGroupModelImpl}. 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.
127            * </p>
128            *
129            * @param start the lower bound of the range of cluster groups
130            * @param end the upper bound of the range of cluster groups (not inclusive)
131            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
132            * @return the ordered range of cluster groups
133            */
134            public java.util.List<com.liferay.portal.model.ClusterGroup> findAll(
135                    int start, int end,
136                    com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.model.ClusterGroup> orderByComparator);
137    
138            /**
139            * Removes all the cluster groups from the database.
140            */
141            public void removeAll();
142    
143            /**
144            * Returns the number of cluster groups.
145            *
146            * @return the number of cluster groups
147            */
148            public int countAll();
149    }