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 MembershipRequest. 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 MembershipRequestLocalServiceUtil 034 * @see com.liferay.portal.service.base.MembershipRequestLocalServiceBaseImpl 035 * @see com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl 036 * @generated 037 */ 038 @ProviderType 039 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 040 PortalException.class, SystemException.class}) 041 public interface MembershipRequestLocalService extends BaseLocalService, 042 PersistedModelLocalService { 043 /* 044 * NOTE FOR DEVELOPERS: 045 * 046 * Never modify or reference this interface directly. Always use {@link MembershipRequestLocalServiceUtil} to access the membership request local service. Add custom service methods to {@link com.liferay.portal.service.impl.MembershipRequestLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface. 047 */ 048 049 /** 050 * Adds the membership request to the database. Also notifies the appropriate model listeners. 051 * 052 * @param membershipRequest the membership request 053 * @return the membership request that was added 054 */ 055 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 056 public com.liferay.portal.model.MembershipRequest addMembershipRequest( 057 com.liferay.portal.model.MembershipRequest membershipRequest); 058 059 public com.liferay.portal.model.MembershipRequest addMembershipRequest( 060 long userId, long groupId, java.lang.String comments, 061 com.liferay.portal.service.ServiceContext serviceContext) 062 throws com.liferay.portal.kernel.exception.PortalException; 063 064 /** 065 * Creates a new membership request with the primary key. Does not add the membership request to the database. 066 * 067 * @param membershipRequestId the primary key for the new membership request 068 * @return the new membership request 069 */ 070 public com.liferay.portal.model.MembershipRequest createMembershipRequest( 071 long membershipRequestId); 072 073 /** 074 * Deletes the membership request from the database. Also notifies the appropriate model listeners. 075 * 076 * @param membershipRequest the membership request 077 * @return the membership request that was removed 078 */ 079 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 080 public com.liferay.portal.model.MembershipRequest deleteMembershipRequest( 081 com.liferay.portal.model.MembershipRequest membershipRequest); 082 083 /** 084 * Deletes the membership request with the primary key from the database. Also notifies the appropriate model listeners. 085 * 086 * @param membershipRequestId the primary key of the membership request 087 * @return the membership request that was removed 088 * @throws PortalException if a membership request with the primary key could not be found 089 */ 090 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE) 091 public com.liferay.portal.model.MembershipRequest deleteMembershipRequest( 092 long membershipRequestId) 093 throws com.liferay.portal.kernel.exception.PortalException; 094 095 public void deleteMembershipRequests(long groupId); 096 097 public void deleteMembershipRequests(long groupId, int statusId); 098 099 public void deleteMembershipRequestsByUserId(long userId); 100 101 /** 102 * @throws PortalException 103 */ 104 @Override 105 public com.liferay.portal.model.PersistedModel deletePersistedModel( 106 com.liferay.portal.model.PersistedModel persistedModel) 107 throws com.liferay.portal.kernel.exception.PortalException; 108 109 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 110 111 /** 112 * Performs a dynamic query on the database and returns the matching rows. 113 * 114 * @param dynamicQuery the dynamic query 115 * @return the matching rows 116 */ 117 public <T> java.util.List<T> dynamicQuery( 118 com.liferay.portal.kernel.dao.orm.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.MembershipRequestModelImpl}. 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> java.util.List<T> dynamicQuery( 133 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 134 int end); 135 136 /** 137 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 138 * 139 * <p> 140 * 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.MembershipRequestModelImpl}. 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. 141 * </p> 142 * 143 * @param dynamicQuery the dynamic query 144 * @param start the lower bound of the range of model instances 145 * @param end the upper bound of the range of model instances (not inclusive) 146 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 147 * @return the ordered range of matching rows 148 */ 149 public <T> java.util.List<T> dynamicQuery( 150 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 151 int end, 152 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 153 154 /** 155 * Returns the number of rows matching the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows matching the dynamic query 159 */ 160 public long dynamicQueryCount( 161 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 162 163 /** 164 * Returns the number of rows matching the dynamic query. 165 * 166 * @param dynamicQuery the dynamic query 167 * @param projection the projection to apply to the query 168 * @return the number of rows matching the dynamic query 169 */ 170 public long dynamicQueryCount( 171 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 172 com.liferay.portal.kernel.dao.orm.Projection projection); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.model.MembershipRequest fetchMembershipRequest( 176 long membershipRequestId); 177 178 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 179 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 180 181 /** 182 * Returns the Spring bean ID for this bean. 183 * 184 * @return the Spring bean ID for this bean 185 */ 186 public java.lang.String getBeanIdentifier(); 187 188 /** 189 * Returns the membership request with the primary key. 190 * 191 * @param membershipRequestId the primary key of the membership request 192 * @return the membership request 193 * @throws PortalException if a membership request with the primary key could not be found 194 */ 195 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 196 public com.liferay.portal.model.MembershipRequest getMembershipRequest( 197 long membershipRequestId) 198 throws com.liferay.portal.kernel.exception.PortalException; 199 200 /** 201 * Returns a range of all the membership requests. 202 * 203 * <p> 204 * 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.MembershipRequestModelImpl}. 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. 205 * </p> 206 * 207 * @param start the lower bound of the range of membership requests 208 * @param end the upper bound of the range of membership requests (not inclusive) 209 * @return the range of membership requests 210 */ 211 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 212 public java.util.List<com.liferay.portal.model.MembershipRequest> getMembershipRequests( 213 int start, int end); 214 215 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 216 public java.util.List<com.liferay.portal.model.MembershipRequest> getMembershipRequests( 217 long userId, long groupId, int statusId); 218 219 /** 220 * Returns the number of membership requests. 221 * 222 * @return the number of membership requests 223 */ 224 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 225 public int getMembershipRequestsCount(); 226 227 @Override 228 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 229 public com.liferay.portal.model.PersistedModel getPersistedModel( 230 java.io.Serializable primaryKeyObj) 231 throws com.liferay.portal.kernel.exception.PortalException; 232 233 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 234 public boolean hasMembershipRequest(long userId, long groupId, int statusId); 235 236 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 237 public java.util.List<com.liferay.portal.model.MembershipRequest> search( 238 long groupId, int status, int start, int end); 239 240 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 241 public int searchCount(long groupId, int status); 242 243 /** 244 * Sets the Spring bean ID for this bean. 245 * 246 * @param beanIdentifier the Spring bean ID for this bean 247 */ 248 public void setBeanIdentifier(java.lang.String beanIdentifier); 249 250 /** 251 * Updates the membership request in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 252 * 253 * @param membershipRequest the membership request 254 * @return the membership request that was updated 255 */ 256 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 257 public com.liferay.portal.model.MembershipRequest updateMembershipRequest( 258 com.liferay.portal.model.MembershipRequest membershipRequest); 259 260 public void updateStatus(long replierUserId, long membershipRequestId, 261 java.lang.String replyComments, int statusId, boolean addUserToGroup, 262 com.liferay.portal.service.ServiceContext serviceContext) 263 throws com.liferay.portal.kernel.exception.PortalException; 264 }