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