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