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.kernel.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.model.ClusterGroup;
026    import com.liferay.portal.kernel.model.PersistedModel;
027    import com.liferay.portal.kernel.search.Indexable;
028    import com.liferay.portal.kernel.search.IndexableType;
029    import com.liferay.portal.kernel.transaction.Isolation;
030    import com.liferay.portal.kernel.transaction.Propagation;
031    import com.liferay.portal.kernel.transaction.Transactional;
032    import com.liferay.portal.kernel.util.OrderByComparator;
033    
034    import java.io.Serializable;
035    
036    import java.util.List;
037    
038    /**
039     * Provides the local service interface for ClusterGroup. Methods of this
040     * service will not have security checks based on the propagated JAAS
041     * credentials because this service can only be accessed from within the same
042     * VM.
043     *
044     * @author Brian Wing Shun Chan
045     * @see ClusterGroupLocalServiceUtil
046     * @see com.liferay.portal.service.base.ClusterGroupLocalServiceBaseImpl
047     * @see com.liferay.portal.service.impl.ClusterGroupLocalServiceImpl
048     * @generated
049     */
050    @ProviderType
051    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
052            PortalException.class, SystemException.class})
053    public interface ClusterGroupLocalService extends BaseLocalService,
054            PersistedModelLocalService {
055            /*
056             * NOTE FOR DEVELOPERS:
057             *
058             * Never modify or reference this interface directly. Always use {@link ClusterGroupLocalServiceUtil} to access the cluster group local service. Add custom service methods to {@link com.liferay.portal.service.impl.ClusterGroupLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
059             */
060            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
061            public ActionableDynamicQuery getActionableDynamicQuery();
062    
063            public DynamicQuery dynamicQuery();
064    
065            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
066            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
067    
068            /**
069            * Adds the cluster group to the database. Also notifies the appropriate model listeners.
070            *
071            * @param clusterGroup the cluster group
072            * @return the cluster group that was added
073            */
074            @Indexable(type = IndexableType.REINDEX)
075            public ClusterGroup addClusterGroup(ClusterGroup clusterGroup);
076    
077            public ClusterGroup addClusterGroup(java.lang.String name,
078                    List<java.lang.String> clusterNodeIds);
079    
080            public ClusterGroup addWholeClusterGroup(java.lang.String name);
081    
082            /**
083            * Creates a new cluster group with the primary key. Does not add the cluster group to the database.
084            *
085            * @param clusterGroupId the primary key for the new cluster group
086            * @return the new cluster group
087            */
088            public ClusterGroup createClusterGroup(long clusterGroupId);
089    
090            /**
091            * Deletes the cluster group from the database. Also notifies the appropriate model listeners.
092            *
093            * @param clusterGroup the cluster group
094            * @return the cluster group that was removed
095            */
096            @Indexable(type = IndexableType.DELETE)
097            public ClusterGroup deleteClusterGroup(ClusterGroup clusterGroup);
098    
099            /**
100            * Deletes the cluster group with the primary key from the database. Also notifies the appropriate model listeners.
101            *
102            * @param clusterGroupId the primary key of the cluster group
103            * @return the cluster group that was removed
104            * @throws PortalException if a cluster group with the primary key could not be found
105            */
106            @Indexable(type = IndexableType.DELETE)
107            public ClusterGroup deleteClusterGroup(long clusterGroupId)
108                    throws PortalException;
109    
110            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111            public ClusterGroup fetchClusterGroup(long clusterGroupId);
112    
113            /**
114            * Returns the cluster group with the primary key.
115            *
116            * @param clusterGroupId the primary key of the cluster group
117            * @return the cluster group
118            * @throws PortalException if a cluster group with the primary key could not be found
119            */
120            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
121            public ClusterGroup getClusterGroup(long clusterGroupId)
122                    throws PortalException;
123    
124            /**
125            * Updates the cluster group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
126            *
127            * @param clusterGroup the cluster group
128            * @return the cluster group that was updated
129            */
130            @Indexable(type = IndexableType.REINDEX)
131            public ClusterGroup updateClusterGroup(ClusterGroup clusterGroup);
132    
133            /**
134            * @throws PortalException
135            */
136            @Override
137            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
138                    throws PortalException;
139    
140            @Override
141            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
143                    throws PortalException;
144    
145            /**
146            * Returns the number of cluster groups.
147            *
148            * @return the number of cluster groups
149            */
150            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
151            public int getClusterGroupsCount();
152    
153            /**
154            * Returns the OSGi service identifier.
155            *
156            * @return the OSGi service identifier
157            */
158            public java.lang.String getOSGiServiceIdentifier();
159    
160            /**
161            * Performs a dynamic query on the database and returns the matching rows.
162            *
163            * @param dynamicQuery the dynamic query
164            * @return the matching rows
165            */
166            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
167    
168            /**
169            * Performs a dynamic query on the database and returns a range of the matching rows.
170            *
171            * <p>
172            * 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.
173            * </p>
174            *
175            * @param dynamicQuery the dynamic query
176            * @param start the lower bound of the range of model instances
177            * @param end the upper bound of the range of model instances (not inclusive)
178            * @return the range of matching rows
179            */
180            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
181                    int end);
182    
183            /**
184            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param dynamicQuery the dynamic query
191            * @param start the lower bound of the range of model instances
192            * @param end the upper bound of the range of model instances (not inclusive)
193            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
194            * @return the ordered range of matching rows
195            */
196            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
197                    int end, OrderByComparator<T> orderByComparator);
198    
199            /**
200            * Returns a range of all the cluster groups.
201            *
202            * <p>
203            * 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.
204            * </p>
205            *
206            * @param start the lower bound of the range of cluster groups
207            * @param end the upper bound of the range of cluster groups (not inclusive)
208            * @return the range of cluster groups
209            */
210            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211            public List<ClusterGroup> getClusterGroups(int start, int end);
212    
213            /**
214            * Returns the number of rows matching the dynamic query.
215            *
216            * @param dynamicQuery the dynamic query
217            * @return the number of rows matching the dynamic query
218            */
219            public long dynamicQueryCount(DynamicQuery dynamicQuery);
220    
221            /**
222            * Returns the number of rows matching the dynamic query.
223            *
224            * @param dynamicQuery the dynamic query
225            * @param projection the projection to apply to the query
226            * @return the number of rows matching the dynamic query
227            */
228            public long dynamicQueryCount(DynamicQuery dynamicQuery,
229                    Projection projection);
230    }