001    /**
002     * Copyright (c) 2000-2011 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 com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    
023    /**
024     * The interface for the service component local service.
025     *
026     * <p>
027     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see ServiceComponentLocalServiceUtil
032     * @see com.liferay.portal.service.base.ServiceComponentLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.ServiceComponentLocalServiceImpl
034     * @generated
035     */
036    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
037            PortalException.class, SystemException.class})
038    public interface ServiceComponentLocalService extends PersistedModelLocalService {
039            /*
040             * NOTE FOR DEVELOPERS:
041             *
042             * 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.
043             */
044    
045            /**
046            * Adds the service component to the database. Also notifies the appropriate model listeners.
047            *
048            * @param serviceComponent the service component
049            * @return the service component that was added
050            * @throws SystemException if a system exception occurred
051            */
052            public com.liferay.portal.model.ServiceComponent addServiceComponent(
053                    com.liferay.portal.model.ServiceComponent serviceComponent)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            /**
057            * Creates a new service component with the primary key. Does not add the service component to the database.
058            *
059            * @param serviceComponentId the primary key for the new service component
060            * @return the new service component
061            */
062            public com.liferay.portal.model.ServiceComponent createServiceComponent(
063                    long serviceComponentId);
064    
065            /**
066            * Deletes the service component with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param serviceComponentId the primary key of the service component
069            * @throws PortalException if a service component with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public void deleteServiceComponent(long serviceComponentId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException;
075    
076            /**
077            * Deletes the service component from the database. Also notifies the appropriate model listeners.
078            *
079            * @param serviceComponent the service component
080            * @throws SystemException if a system exception occurred
081            */
082            public void deleteServiceComponent(
083                    com.liferay.portal.model.ServiceComponent serviceComponent)
084                    throws com.liferay.portal.kernel.exception.SystemException;
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException;
097    
098            /**
099            * Performs a dynamic query on the database and returns a range of the matching rows.
100            *
101            * <p>
102            * 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.
103            * </p>
104            *
105            * @param dynamicQuery the dynamic query
106            * @param start the lower bound of the range of model instances
107            * @param end the upper bound of the range of model instances (not inclusive)
108            * @return the range of matching rows
109            * @throws SystemException if a system exception occurred
110            */
111            @SuppressWarnings("rawtypes")
112            public java.util.List dynamicQuery(
113                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
114                    int end) throws com.liferay.portal.kernel.exception.SystemException;
115    
116            /**
117            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
118            *
119            * <p>
120            * 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.
121            * </p>
122            *
123            * @param dynamicQuery the dynamic query
124            * @param start the lower bound of the range of model instances
125            * @param end the upper bound of the range of model instances (not inclusive)
126            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
127            * @return the ordered range of matching rows
128            * @throws SystemException if a system exception occurred
129            */
130            @SuppressWarnings("rawtypes")
131            public java.util.List dynamicQuery(
132                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
133                    int end,
134                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
135                    throws com.liferay.portal.kernel.exception.SystemException;
136    
137            /**
138            * Returns the number of rows that match the dynamic query.
139            *
140            * @param dynamicQuery the dynamic query
141            * @return the number of rows that match the dynamic query
142            * @throws SystemException if a system exception occurred
143            */
144            public long dynamicQueryCount(
145                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
146                    throws com.liferay.portal.kernel.exception.SystemException;
147    
148            /**
149            * Returns the service component with the primary key.
150            *
151            * @param serviceComponentId the primary key of the service component
152            * @return the service component
153            * @throws PortalException if a service component with the primary key could not be found
154            * @throws SystemException if a system exception occurred
155            */
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portal.model.ServiceComponent getServiceComponent(
158                    long serviceComponentId)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException;
161    
162            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
163            public com.liferay.portal.model.PersistedModel getPersistedModel(
164                    java.io.Serializable primaryKeyObj)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException;
167    
168            /**
169            * Returns a range of all the service components.
170            *
171            * <p>
172            * 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.
173            * </p>
174            *
175            * @param start the lower bound of the range of service components
176            * @param end the upper bound of the range of service components (not inclusive)
177            * @return the range of service components
178            * @throws SystemException if a system exception occurred
179            */
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public java.util.List<com.liferay.portal.model.ServiceComponent> getServiceComponents(
182                    int start, int end)
183                    throws com.liferay.portal.kernel.exception.SystemException;
184    
185            /**
186            * Returns the number of service components.
187            *
188            * @return the number of service components
189            * @throws SystemException if a system exception occurred
190            */
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public int getServiceComponentsCount()
193                    throws com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Updates the service component in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
197            *
198            * @param serviceComponent the service component
199            * @return the service component that was updated
200            * @throws SystemException if a system exception occurred
201            */
202            public com.liferay.portal.model.ServiceComponent updateServiceComponent(
203                    com.liferay.portal.model.ServiceComponent serviceComponent)
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Updates the service component in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
208            *
209            * @param serviceComponent the service component
210            * @param merge whether to merge the service component with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
211            * @return the service component that was updated
212            * @throws SystemException if a system exception occurred
213            */
214            public com.liferay.portal.model.ServiceComponent updateServiceComponent(
215                    com.liferay.portal.model.ServiceComponent serviceComponent,
216                    boolean merge)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Returns the Spring bean ID for this bean.
221            *
222            * @return the Spring bean ID for this bean
223            */
224            public java.lang.String getBeanIdentifier();
225    
226            /**
227            * Sets the Spring bean ID for this bean.
228            *
229            * @param beanIdentifier the Spring bean ID for this bean
230            */
231            public void setBeanIdentifier(java.lang.String beanIdentifier);
232    
233            public void destroyServiceComponent(
234                    javax.servlet.ServletContext servletContext,
235                    java.lang.ClassLoader classLoader)
236                    throws com.liferay.portal.kernel.exception.SystemException;
237    
238            public com.liferay.portal.model.ServiceComponent initServiceComponent(
239                    javax.servlet.ServletContext servletContext,
240                    java.lang.ClassLoader classLoader, java.lang.String buildNamespace,
241                    long buildNumber, long buildDate, boolean buildAutoUpgrade)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException;
244    
245            public void upgradeDB(java.lang.ClassLoader classLoader,
246                    java.lang.String buildNamespace, long buildNumber,
247                    boolean buildAutoUpgrade,
248                    com.liferay.portal.model.ServiceComponent previousServiceComponent,
249                    java.lang.String tablesSQL, java.lang.String sequencesSQL,
250                    java.lang.String indexesSQL) throws java.lang.Exception;
251    
252            public void verifyDB()
253                    throws com.liferay.portal.kernel.exception.SystemException;
254    }