001 /** 002 * Copyright (c) 2000-2013 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 * @throws SystemException if a system exception occurred 071 */ 072 public com.liferay.portal.model.ClusterGroup remove(long clusterGroupId) 073 throws com.liferay.portal.NoSuchClusterGroupException, 074 com.liferay.portal.kernel.exception.SystemException; 075 076 public com.liferay.portal.model.ClusterGroup updateImpl( 077 com.liferay.portal.model.ClusterGroup clusterGroup) 078 throws com.liferay.portal.kernel.exception.SystemException; 079 080 /** 081 * Returns the cluster group with the primary key or throws a {@link com.liferay.portal.NoSuchClusterGroupException} if it could not be found. 082 * 083 * @param clusterGroupId the primary key of the cluster group 084 * @return the cluster group 085 * @throws com.liferay.portal.NoSuchClusterGroupException if a cluster group with the primary key could not be found 086 * @throws SystemException if a system exception occurred 087 */ 088 public com.liferay.portal.model.ClusterGroup findByPrimaryKey( 089 long clusterGroupId) 090 throws com.liferay.portal.NoSuchClusterGroupException, 091 com.liferay.portal.kernel.exception.SystemException; 092 093 /** 094 * Returns the cluster group with the primary key or returns <code>null</code> if it could not be found. 095 * 096 * @param clusterGroupId the primary key of the cluster group 097 * @return the cluster group, or <code>null</code> if a cluster group with the primary key could not be found 098 * @throws SystemException if a system exception occurred 099 */ 100 public com.liferay.portal.model.ClusterGroup fetchByPrimaryKey( 101 long clusterGroupId) 102 throws com.liferay.portal.kernel.exception.SystemException; 103 104 /** 105 * Returns all the cluster groups. 106 * 107 * @return the cluster groups 108 * @throws SystemException if a system exception occurred 109 */ 110 public java.util.List<com.liferay.portal.model.ClusterGroup> findAll() 111 throws com.liferay.portal.kernel.exception.SystemException; 112 113 /** 114 * Returns a range of all the cluster groups. 115 * 116 * <p> 117 * 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. 118 * </p> 119 * 120 * @param start the lower bound of the range of cluster groups 121 * @param end the upper bound of the range of cluster groups (not inclusive) 122 * @return the range of cluster groups 123 * @throws SystemException if a system exception occurred 124 */ 125 public java.util.List<com.liferay.portal.model.ClusterGroup> findAll( 126 int start, int end) 127 throws com.liferay.portal.kernel.exception.SystemException; 128 129 /** 130 * Returns an ordered range of all the cluster groups. 131 * 132 * <p> 133 * 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. 134 * </p> 135 * 136 * @param start the lower bound of the range of cluster groups 137 * @param end the upper bound of the range of cluster groups (not inclusive) 138 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 139 * @return the ordered range of cluster groups 140 * @throws SystemException if a system exception occurred 141 */ 142 public java.util.List<com.liferay.portal.model.ClusterGroup> findAll( 143 int start, int end, 144 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 145 throws com.liferay.portal.kernel.exception.SystemException; 146 147 /** 148 * Removes all the cluster groups from the database. 149 * 150 * @throws SystemException if a system exception occurred 151 */ 152 public void removeAll() 153 throws com.liferay.portal.kernel.exception.SystemException; 154 155 /** 156 * Returns the number of cluster groups. 157 * 158 * @return the number of cluster groups 159 * @throws SystemException if a system exception occurred 160 */ 161 public int countAll() 162 throws com.liferay.portal.kernel.exception.SystemException; 163 }