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.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.search.Indexable; 026 import com.liferay.portal.kernel.search.IndexableType; 027 import com.liferay.portal.kernel.spring.aop.Skip; 028 import com.liferay.portal.kernel.transaction.Isolation; 029 import com.liferay.portal.kernel.transaction.Propagation; 030 import com.liferay.portal.kernel.transaction.Transactional; 031 import com.liferay.portal.kernel.util.OrderByComparator; 032 import com.liferay.portal.model.ClassName; 033 import com.liferay.portal.model.PersistedModel; 034 035 import java.io.Serializable; 036 037 import java.util.List; 038 039 /** 040 * Provides the local service interface for ClassName. Methods of this 041 * service will not have security checks based on the propagated JAAS 042 * credentials because this service can only be accessed from within the same 043 * VM. 044 * 045 * @author Brian Wing Shun Chan 046 * @see ClassNameLocalServiceUtil 047 * @see com.liferay.portal.service.base.ClassNameLocalServiceBaseImpl 048 * @see com.liferay.portal.service.impl.ClassNameLocalServiceImpl 049 * @generated 050 */ 051 @ProviderType 052 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 053 PortalException.class, SystemException.class}) 054 public interface ClassNameLocalService extends BaseLocalService, 055 PersistedModelLocalService { 056 /* 057 * NOTE FOR DEVELOPERS: 058 * 059 * 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. 060 */ 061 062 /** 063 * Adds the class name to the database. Also notifies the appropriate model listeners. 064 * 065 * @param className the class name 066 * @return the class name that was added 067 */ 068 @Indexable(type = IndexableType.REINDEX) 069 public ClassName addClassName(ClassName className); 070 071 public ClassName addClassName(java.lang.String value); 072 073 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 074 public void checkClassNames(); 075 076 /** 077 * Creates a new class name with the primary key. Does not add the class name to the database. 078 * 079 * @param classNameId the primary key for the new class name 080 * @return the new class name 081 */ 082 public ClassName createClassName(long classNameId); 083 084 /** 085 * Deletes the class name from the database. Also notifies the appropriate model listeners. 086 * 087 * @param className the class name 088 * @return the class name that was removed 089 */ 090 @Indexable(type = IndexableType.DELETE) 091 public ClassName deleteClassName(ClassName className); 092 093 /** 094 * Deletes the class name with the primary key from the database. Also notifies the appropriate model listeners. 095 * 096 * @param classNameId the primary key of the class name 097 * @return the class name that was removed 098 * @throws PortalException if a class name with the primary key could not be found 099 */ 100 @Indexable(type = IndexableType.DELETE) 101 public ClassName deleteClassName(long classNameId) 102 throws PortalException; 103 104 /** 105 * @throws PortalException 106 */ 107 @Override 108 public PersistedModel deletePersistedModel(PersistedModel persistedModel) 109 throws PortalException; 110 111 public DynamicQuery dynamicQuery(); 112 113 /** 114 * Performs a dynamic query on the database and returns the matching rows. 115 * 116 * @param dynamicQuery the dynamic query 117 * @return the matching rows 118 */ 119 public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery); 120 121 /** 122 * Performs a dynamic query on the database and returns a range of the matching rows. 123 * 124 * <p> 125 * 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. 126 * </p> 127 * 128 * @param dynamicQuery the dynamic query 129 * @param start the lower bound of the range of model instances 130 * @param end the upper bound of the range of model instances (not inclusive) 131 * @return the range of matching rows 132 */ 133 public <T> List<T> dynamicQuery(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.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. 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> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, 150 int end, OrderByComparator<T> orderByComparator); 151 152 /** 153 * Returns the number of rows matching the dynamic query. 154 * 155 * @param dynamicQuery the dynamic query 156 * @return the number of rows matching the dynamic query 157 */ 158 public long dynamicQueryCount(DynamicQuery dynamicQuery); 159 160 /** 161 * Returns the number of rows matching the dynamic query. 162 * 163 * @param dynamicQuery the dynamic query 164 * @param projection the projection to apply to the query 165 * @return the number of rows matching the dynamic query 166 */ 167 public long dynamicQueryCount(DynamicQuery dynamicQuery, 168 Projection projection); 169 170 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 171 public ClassName fetchClassName(long classNameId); 172 173 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 174 public ClassName fetchClassName(java.lang.String value); 175 176 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 177 public ActionableDynamicQuery getActionableDynamicQuery(); 178 179 /** 180 * Returns the class name with the primary key. 181 * 182 * @param classNameId the primary key of the class name 183 * @return the class name 184 * @throws PortalException if a class name with the primary key could not be found 185 */ 186 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 187 public ClassName getClassName(long classNameId) throws PortalException; 188 189 @Skip 190 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 191 public ClassName getClassName(java.lang.String value); 192 193 @Skip 194 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 195 public long getClassNameId(java.lang.Class<?> clazz); 196 197 @Skip 198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 199 public long getClassNameId(java.lang.String value); 200 201 /** 202 * Returns a range of all the class names. 203 * 204 * <p> 205 * 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. 206 * </p> 207 * 208 * @param start the lower bound of the range of class names 209 * @param end the upper bound of the range of class names (not inclusive) 210 * @return the range of class names 211 */ 212 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 213 public List<ClassName> getClassNames(int start, int end); 214 215 /** 216 * Returns the number of class names. 217 * 218 * @return the number of class names 219 */ 220 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 221 public int getClassNamesCount(); 222 223 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 224 public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery(); 225 226 /** 227 * Returns the OSGi service identifier. 228 * 229 * @return the OSGi service identifier 230 */ 231 public java.lang.String getOSGiServiceIdentifier(); 232 233 @Override 234 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 235 public PersistedModel getPersistedModel(Serializable primaryKeyObj) 236 throws PortalException; 237 238 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 239 public java.lang.String getRegistryName(); 240 241 public void invalidate(); 242 243 /** 244 * Updates the class name in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 245 * 246 * @param className the class name 247 * @return the class name that was updated 248 */ 249 @Indexable(type = IndexableType.REINDEX) 250 public ClassName updateClassName(ClassName className); 251 }