001    /**
002     * Copyright (c) 2000-2010 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.portlet.expando.service;
016    
017    import com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the expando table local service.
025     *
026     * <p>
027     * Never modify or reference this interface directly. Always use {@link ExpandoTableLocalServiceUtil} to access the expando table local service. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see ExpandoTableLocalServiceUtil
036     * @see com.liferay.portlet.expando.service.base.ExpandoTableLocalServiceBaseImpl
037     * @see com.liferay.portlet.expando.service.impl.ExpandoTableLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface ExpandoTableLocalService {
043            /**
044            * Adds the expando table to the database. Also notifies the appropriate model listeners.
045            *
046            * @param expandoTable the expando table to add
047            * @return the expando table that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.expando.model.ExpandoTable addExpandoTable(
051                    com.liferay.portlet.expando.model.ExpandoTable expandoTable)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new expando table with the primary key. Does not add the expando table to the database.
056            *
057            * @param tableId the primary key for the new expando table
058            * @return the new expando table
059            */
060            public com.liferay.portlet.expando.model.ExpandoTable createExpandoTable(
061                    long tableId);
062    
063            /**
064            * Deletes the expando table with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param tableId the primary key of the expando table to delete
067            * @throws PortalException if a expando table with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteExpandoTable(long tableId)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the expando table from the database. Also notifies the appropriate model listeners.
076            *
077            * @param expandoTable the expando table to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteExpandoTable(
081                    com.liferay.portlet.expando.model.ExpandoTable expandoTable)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the expando table with the primary key.
148            *
149            * @param tableId the primary key of the expando table to get
150            * @return the expando table
151            * @throws PortalException if a expando table with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.expando.model.ExpandoTable getExpandoTable(
156                    long tableId)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets a range of all the expando tables.
162            *
163            * <p>
164            * 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.
165            * </p>
166            *
167            * @param start the lower bound of the range of expando tables to return
168            * @param end the upper bound of the range of expando tables to return (not inclusive)
169            * @return the range of expando tables
170            * @throws SystemException if a system exception occurred
171            */
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getExpandoTables(
174                    int start, int end)
175                    throws com.liferay.portal.kernel.exception.SystemException;
176    
177            /**
178            * Gets the number of expando tables.
179            *
180            * @return the number of expando tables
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public int getExpandoTablesCount()
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Updates the expando table in the database. Also notifies the appropriate model listeners.
189            *
190            * @param expandoTable the expando table to update
191            * @return the expando table that was updated
192            * @throws SystemException if a system exception occurred
193            */
194            public com.liferay.portlet.expando.model.ExpandoTable updateExpandoTable(
195                    com.liferay.portlet.expando.model.ExpandoTable expandoTable)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Updates the expando table in the database. Also notifies the appropriate model listeners.
200            *
201            * @param expandoTable the expando table to update
202            * @param merge whether to merge the expando table 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.
203            * @return the expando table that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portlet.expando.model.ExpandoTable updateExpandoTable(
207                    com.liferay.portlet.expando.model.ExpandoTable expandoTable,
208                    boolean merge)
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            public com.liferay.portlet.expando.model.ExpandoTable addDefaultTable(
212                    long companyId, long classNameId)
213                    throws com.liferay.portal.kernel.exception.PortalException,
214                            com.liferay.portal.kernel.exception.SystemException;
215    
216            public com.liferay.portlet.expando.model.ExpandoTable addDefaultTable(
217                    long companyId, java.lang.String className)
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException;
220    
221            public com.liferay.portlet.expando.model.ExpandoTable addTable(
222                    long companyId, long classNameId, java.lang.String name)
223                    throws com.liferay.portal.kernel.exception.PortalException,
224                            com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * @deprecated {@link #addTable(long, long, String)}
228            */
229            public com.liferay.portlet.expando.model.ExpandoTable addTable(
230                    long classNameId, java.lang.String name)
231                    throws com.liferay.portal.kernel.exception.PortalException,
232                            com.liferay.portal.kernel.exception.SystemException;
233    
234            public com.liferay.portlet.expando.model.ExpandoTable addTable(
235                    long companyId, java.lang.String className, java.lang.String name)
236                    throws com.liferay.portal.kernel.exception.PortalException,
237                            com.liferay.portal.kernel.exception.SystemException;
238    
239            /**
240            * @deprecated {@link #addTable(long, String, String)}
241            */
242            public com.liferay.portlet.expando.model.ExpandoTable addTable(
243                    java.lang.String className, java.lang.String name)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void deleteTable(
248                    com.liferay.portlet.expando.model.ExpandoTable table)
249                    throws com.liferay.portal.kernel.exception.SystemException;
250    
251            public void deleteTable(long tableId)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            public void deleteTable(long companyId, long classNameId,
256                    java.lang.String name)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void deleteTable(long companyId, java.lang.String className,
261                    java.lang.String name)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void deleteTables(long companyId, long classNameId)
266                    throws com.liferay.portal.kernel.exception.SystemException;
267    
268            public void deleteTables(long companyId, java.lang.String className)
269                    throws com.liferay.portal.kernel.exception.SystemException;
270    
271            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
272            public com.liferay.portlet.expando.model.ExpandoTable getDefaultTable(
273                    long companyId, long classNameId)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public com.liferay.portlet.expando.model.ExpandoTable getDefaultTable(
279                    long companyId, java.lang.String className)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public com.liferay.portlet.expando.model.ExpandoTable getTable(long tableId)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException;
287    
288            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
289            public com.liferay.portlet.expando.model.ExpandoTable getTable(
290                    long companyId, long classNameId, java.lang.String name)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException;
293    
294            /**
295            * @deprecated {@link #getTable(long, long, String)}
296            */
297            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
298            public com.liferay.portlet.expando.model.ExpandoTable getTable(
299                    long classNameId, java.lang.String name)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public com.liferay.portlet.expando.model.ExpandoTable getTable(
305                    long companyId, java.lang.String className, java.lang.String name)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException;
308    
309            /**
310            * @deprecated {@link #getTable(long, String, String)}
311            */
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public com.liferay.portlet.expando.model.ExpandoTable getTable(
314                    java.lang.String className, java.lang.String name)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getTables(
320                    long companyId, long classNameId)
321                    throws com.liferay.portal.kernel.exception.SystemException;
322    
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public java.util.List<com.liferay.portlet.expando.model.ExpandoTable> getTables(
325                    long companyId, java.lang.String className)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            public com.liferay.portlet.expando.model.ExpandoTable updateTable(
329                    long tableId, java.lang.String name)
330                    throws com.liferay.portal.kernel.exception.PortalException,
331                            com.liferay.portal.kernel.exception.SystemException;
332    }