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