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