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