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