001    /**
002     * Copyright (c) 2000-2013 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.BaseLocalService;
023    import com.liferay.portal.service.PersistedModelLocalService;
024    
025    /**
026     * The interface for the expando row local service.
027     *
028     * <p>
029     * 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.
030     * </p>
031     *
032     * @author Brian Wing Shun Chan
033     * @see ExpandoRowLocalServiceUtil
034     * @see com.liferay.portlet.expando.service.base.ExpandoRowLocalServiceBaseImpl
035     * @see com.liferay.portlet.expando.service.impl.ExpandoRowLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface ExpandoRowLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * 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.
046             */
047    
048            /**
049            * Adds the expando row to the database. Also notifies the appropriate model listeners.
050            *
051            * @param expandoRow the expando row
052            * @return the expando row that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.expando.model.ExpandoRow addExpandoRow(
056                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new expando row with the primary key. Does not add the expando row to the database.
061            *
062            * @param rowId the primary key for the new expando row
063            * @return the new expando row
064            */
065            public com.liferay.portlet.expando.model.ExpandoRow createExpandoRow(
066                    long rowId);
067    
068            /**
069            * Deletes the expando row with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param rowId the primary key of the expando row
072            * @return the expando row that was removed
073            * @throws PortalException if a expando row with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.expando.model.ExpandoRow deleteExpandoRow(
077                    long rowId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the expando row from the database. Also notifies the appropriate model listeners.
083            *
084            * @param expandoRow the expando row
085            * @return the expando row that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.expando.model.ExpandoRow deleteExpandoRow(
089                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
090                    throws com.liferay.portal.kernel.exception.SystemException;
091    
092            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException;
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.portlet.expando.model.impl.ExpandoRowModelImpl}. 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException;
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.portlet.expando.model.impl.ExpandoRowModelImpl}. 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException;
144    
145            /**
146            * Returns the number of rows that match the dynamic query.
147            *
148            * @param dynamicQuery the dynamic query
149            * @return the number of rows that match the dynamic query
150            * @throws SystemException if a system exception occurred
151            */
152            public long dynamicQueryCount(
153                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
154                    throws com.liferay.portal.kernel.exception.SystemException;
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public com.liferay.portlet.expando.model.ExpandoRow fetchExpandoRow(
158                    long rowId) throws com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Returns the expando row with the primary key.
162            *
163            * @param rowId the primary key of the expando row
164            * @return the expando row
165            * @throws PortalException if a expando row with the primary key could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169            public com.liferay.portlet.expando.model.ExpandoRow getExpandoRow(
170                    long rowId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException;
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portal.model.PersistedModel getPersistedModel(
176                    java.io.Serializable primaryKeyObj)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException;
179    
180            /**
181            * Returns a range of all the expando rows.
182            *
183            * <p>
184            * 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.portlet.expando.model.impl.ExpandoRowModelImpl}. 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.
185            * </p>
186            *
187            * @param start the lower bound of the range of expando rows
188            * @param end the upper bound of the range of expando rows (not inclusive)
189            * @return the range of expando rows
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getExpandoRows(
194                    int start, int end)
195                    throws com.liferay.portal.kernel.exception.SystemException;
196    
197            /**
198            * Returns the number of expando rows.
199            *
200            * @return the number of expando rows
201            * @throws SystemException if a system exception occurred
202            */
203            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
204            public int getExpandoRowsCount()
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            * @return the expando row that was updated
212            * @throws SystemException if a system exception occurred
213            */
214            public com.liferay.portlet.expando.model.ExpandoRow updateExpandoRow(
215                    com.liferay.portlet.expando.model.ExpandoRow expandoRow)
216                    throws com.liferay.portal.kernel.exception.SystemException;
217    
218            /**
219            * Returns the Spring bean ID for this bean.
220            *
221            * @return the Spring bean ID for this bean
222            */
223            public java.lang.String getBeanIdentifier();
224    
225            /**
226            * Sets the Spring bean ID for this bean.
227            *
228            * @param beanIdentifier the Spring bean ID for this bean
229            */
230            public void setBeanIdentifier(java.lang.String beanIdentifier);
231    
232            public com.liferay.portlet.expando.model.ExpandoRow addRow(long tableId,
233                    long classPK)
234                    throws com.liferay.portal.kernel.exception.PortalException,
235                            com.liferay.portal.kernel.exception.SystemException;
236    
237            public void deleteRow(com.liferay.portlet.expando.model.ExpandoRow row)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            public void deleteRow(long rowId)
241                    throws com.liferay.portal.kernel.exception.PortalException,
242                            com.liferay.portal.kernel.exception.SystemException;
243    
244            public void deleteRow(long tableId, long classPK)
245                    throws com.liferay.portal.kernel.exception.PortalException,
246                            com.liferay.portal.kernel.exception.SystemException;
247    
248            public void deleteRow(long companyId, long classNameId,
249                    java.lang.String tableName, long classPK)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public void deleteRow(long companyId, java.lang.String className,
254                    java.lang.String tableName, long classPK)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException;
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getDefaultTableRows(
260                    long companyId, long classNameId, int start, int end)
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
264            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getDefaultTableRows(
265                    long companyId, java.lang.String className, int start, int end)
266                    throws com.liferay.portal.kernel.exception.SystemException;
267    
268            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
269            public int getDefaultTableRowsCount(long companyId, long classNameId)
270                    throws com.liferay.portal.kernel.exception.SystemException;
271    
272            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273            public int getDefaultTableRowsCount(long companyId,
274                    java.lang.String className)
275                    throws com.liferay.portal.kernel.exception.SystemException;
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public com.liferay.portlet.expando.model.ExpandoRow getRow(long rowId)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public com.liferay.portlet.expando.model.ExpandoRow getRow(long tableId,
284                    long classPK)
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.ExpandoRow getRow(long companyId,
290                    long classNameId, java.lang.String tableName, long classPK)
291                    throws com.liferay.portal.kernel.exception.SystemException;
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public com.liferay.portlet.expando.model.ExpandoRow getRow(long companyId,
295                    java.lang.String className, java.lang.String tableName, long classPK)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
300                    long tableId, int start, int end)
301                    throws com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
305                    long companyId, long classNameId, java.lang.String tableName,
306                    int start, int end)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public java.util.List<com.liferay.portlet.expando.model.ExpandoRow> getRows(
311                    long companyId, java.lang.String className, java.lang.String tableName,
312                    int start, int end)
313                    throws com.liferay.portal.kernel.exception.SystemException;
314    
315            /**
316            * @deprecated As of 6.1.0, replaced by {@link #getRows(long, String,
317            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 As of 6.1.0, replaced by {@link #getRowsCount(long, String,
340            String)}
341            */
342            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
343            public int getRowsCount(java.lang.String className,
344                    java.lang.String tableName)
345                    throws com.liferay.portal.kernel.exception.SystemException;
346    }