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 row 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 ExpandoRowLocalServiceUtil
033     * @see com.liferay.portlet.expando.service.base.ExpandoRowLocalServiceBaseImpl
034     * @see com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface ExpandoRowLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link ExpandoRowLocalServiceUtil} to access the expando row local service. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the expando row to the database. Also notifies the appropriate model listeners.
048            *
049            * @param expandoRow the expando row
050            * @return the expando row that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.expando.model.ExpandoRow addExpandoRow(
054                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new expando row with the primary key. Does not add the expando row to the database.
059            *
060            * @param rowId the primary key for the new expando row
061            * @return the new expando row
062            */
063            public com.liferay.portlet.expando.model.ExpandoRow createExpandoRow(
064                    long rowId);
065    
066            /**
067            * Deletes the expando row with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param rowId the primary key of the expando row
070            * @throws PortalException if a expando row with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteExpandoRow(long rowId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the expando row from the database. Also notifies the appropriate model listeners.
079            *
080            * @param expandoRow the expando row
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteExpandoRow(
084                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
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 row with the primary key.
151            *
152            * @param rowId the primary key of the expando row
153            * @return the expando row
154            * @throws PortalException if a expando row 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.ExpandoRow getExpandoRow(
159                    long rowId)
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 rows.
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 rows
177            * @param end the upper bound of the range of expando rows (not inclusive)
178            * @return the range of expando rows
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.ExpandoRow> getExpandoRows(
183                    int start, int end)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the number of expando rows.
188            *
189            * @return the number of expando rows
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public int getExpandoRowsCount()
194                    throws com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Updates the expando row in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
198            *
199            * @param expandoRow the expando row
200            * @return the expando row that was updated
201            * @throws SystemException if a system exception occurred
202            */
203            public com.liferay.portlet.expando.model.ExpandoRow updateExpandoRow(
204                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Updates the expando row in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
209            *
210            * @param expandoRow the expando row
211            * @param merge whether to merge the expando row 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 row that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.expando.model.ExpandoRow updateExpandoRow(
216                    com.liferay.portlet.expando.model.ExpandoRow expandoRow, 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 com.liferay.portlet.expando.model.ExpandoRow addRow(long tableId,
234                    long classPK)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException;
237    
238            public void deleteRow(com.liferay.portlet.expando.model.ExpandoRow row)
239                    throws com.liferay.portal.kernel.exception.SystemException;
240    
241            public void deleteRow(long rowId)
242                    throws com.liferay.portal.kernel.exception.PortalException,
243                            com.liferay.portal.kernel.exception.SystemException;
244    
245            public void deleteRow(long tableId, long classPK)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException;
248    
249            public void deleteRow(long companyId, long classNameId,
250                    java.lang.String tableName, long classPK)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public void deleteRow(long companyId, java.lang.String className,
255                    java.lang.String tableName, long classPK)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
260            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getDefaultTableRows(
261                    long companyId, long classNameId, int start, int end)
262                    throws com.liferay.portal.kernel.exception.SystemException;
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getDefaultTableRows(
266                    long companyId, java.lang.String className, int start, int end)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public int getDefaultTableRowsCount(long companyId, long classNameId)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public int getDefaultTableRowsCount(long companyId,
275                    java.lang.String className)
276                    throws com.liferay.portal.kernel.exception.SystemException;
277    
278            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
279            public com.liferay.portlet.expando.model.ExpandoRow getRow(long rowId)
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.ExpandoRow getRow(long tableId,
285                    long classPK)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290            public com.liferay.portlet.expando.model.ExpandoRow getRow(long companyId,
291                    long classNameId, java.lang.String tableName, long classPK)
292                    throws com.liferay.portal.kernel.exception.SystemException;
293    
294            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
295            public com.liferay.portlet.expando.model.ExpandoRow getRow(long companyId,
296                    java.lang.String className, java.lang.String tableName, long classPK)
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
301                    long tableId, int start, int end)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
306                    long companyId, long classNameId, java.lang.String tableName,
307                    int start, int end)
308                    throws com.liferay.portal.kernel.exception.SystemException;
309    
310            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
312                    long companyId, java.lang.String className, java.lang.String tableName,
313                    int start, int end)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            /**
317            * @deprecated {@link #getRows(long, String, String, int, int)}
318            */
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
321                    java.lang.String className, java.lang.String tableName, int start,
322                    int end) throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public int getRowsCount(long tableId)
326                    throws com.liferay.portal.kernel.exception.SystemException;
327    
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public int getRowsCount(long companyId, long classNameId,
330                    java.lang.String tableName)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
334            public int getRowsCount(long companyId, java.lang.String className,
335                    java.lang.String tableName)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            /**
339            * @deprecated {@link #getRowsCount(long, String, String)}
340            */
341            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
342            public int getRowsCount(java.lang.String className,
343                    java.lang.String tableName)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    }