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 061 /** 062 * Adds the cluster group to the database. Also notifies the appropriate model listeners. 063 * 064 * @param clusterGroup the cluster group 065 * @return the cluster group that was added 066 */ 067 @Indexable(type = IndexableType.REINDEX) 068 public ClusterGroup addClusterGroup(ClusterGroup clusterGroup); 069 070 public ClusterGroup addClusterGroup(java.lang.String name, 071 List<java.lang.String> clusterNodeIds); 072 073 public ClusterGroup addWholeClusterGroup(java.lang.String name); 074 075 /** 076 * Creates a new cluster group with the primary key. Does not add the cluster group to the database. 077 * 078 * @param clusterGroupId the primary key for the new cluster group 079 * @return the new cluster group 080 */ 081 public ClusterGroup createClusterGroup(long clusterGroupId); 082 083 /** 084 * Deletes the cluster group from the database. Also notifies the appropriate model listeners. 085 * 086 * @param clusterGroup the cluster group 087 * @return the cluster group that was removed 088 */ 089 @Indexable(type = IndexableType.DELETE) 090 public ClusterGroup deleteClusterGroup(ClusterGroup clusterGroup); 091 092 /** 093 * Deletes the cluster group with the primary key from the database. Also notifies the appropriate model listeners. 094 * 095 * @param clusterGroupId the primary key of the cluster group 096 * @return the cluster group that was removed 097 * @throws PortalException if a cluster group with the primary key could not be found 098 */ 099 @Indexable(type = IndexableType.DELETE) 100 public ClusterGroup deleteClusterGroup(long clusterGroupId) 101 throws PortalException; 102 103 /** 104 * @throws PortalException 105 */ 106 @Override 107 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 108 throws PortalException; 109 110 public DynamicQuery dynamicQuery(); 111 112 /** 113 * Performs a dynamic query on the database and returns the matching rows. 114 * 115 * @param dynamicQuery the dynamic query 116 * @return the matching rows 117 */ 118 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 119 120 /** 121 * Performs a dynamic query on the database and returns a range of the matching rows. 122 * 123 * <p> 124 * 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. 125 * </p> 126 * 127 * @param dynamicQuery the dynamic query 128 * @param start the lower bound of the range of model instances 129 * @param end the upper bound of the range of model instances (not inclusive) 130 * @return the range of matching rows 131 */ 132 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 133 int end); 134 135 /** 136 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 137 * 138 * <p> 139 * 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. 140 * </p> 141 * 142 * @param dynamicQuery the dynamic query 143 * @param start the lower bound of the range of model instances 144 * @param end the upper bound of the range of model instances (not inclusive) 145 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 146 * @return the ordered range of matching rows 147 */ 148 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 149 int end, OrderByComparator<T> orderByComparator); 150 151 /** 152 * Returns the number of rows matching the dynamic query. 153 * 154 * @param dynamicQuery the dynamic query 155 * @return the number of rows matching the dynamic query 156 */ 157 public long dynamicQueryCount(DynamicQuery dynamicQuery); 158 159 /** 160 * Returns the number of rows matching the dynamic query. 161 * 162 * @param dynamicQuery the dynamic query 163 * @param projection the projection to apply to the query 164 * @return the number of rows matching the dynamic query 165 */ 166 public long dynamicQueryCount(DynamicQuery dynamicQuery, 167 Projection projection); 168 169 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 170 public ClusterGroup fetchClusterGroup(long clusterGroupId); 171 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public 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 ClusterGroup getClusterGroup(long clusterGroupId) 184 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 List<ClusterGroup> getClusterGroups(int start, int end); 199 200 /** 201 * Returns the number of cluster groups. 202 * 203 * @return the number of cluster groups 204 */ 205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 206 public int getClusterGroupsCount(); 207 208 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 209 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 210 211 /** 212 * Returns the OSGi service identifier. 213 * 214 * @return the OSGi service identifier 215 */ 216 public java.lang.String getOSGiServiceIdentifier(); 217 218 @Override 219 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 220 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 221 throws PortalException; 222 223 /** 224 * Updates the cluster group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 225 * 226 * @param clusterGroup the cluster group 227 * @return the cluster group that was updated 228 */ 229 @Indexable(type = IndexableType.REINDEX) 230 public ClusterGroup updateClusterGroup(ClusterGroup clusterGroup); 231 }