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