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 column 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 ExpandoColumnLocalServiceUtil
034     * @see com.liferay.portlet.expando.service.base.ExpandoColumnLocalServiceBaseImpl
035     * @see com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl
036     * @generated
037     */
038    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
039            PortalException.class, SystemException.class})
040    public interface ExpandoColumnLocalService extends BaseLocalService,
041            PersistedModelLocalService {
042            /*
043             * NOTE FOR DEVELOPERS:
044             *
045             * Never modify or reference this interface directly. Always use {@link ExpandoColumnLocalServiceUtil} to access the expando column local service. Add custom service methods to {@link com.liferay.portlet.expando.service.impl.ExpandoColumnLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
046             */
047    
048            /**
049            * Adds the expando column to the database. Also notifies the appropriate model listeners.
050            *
051            * @param expandoColumn the expando column
052            * @return the expando column that was added
053            * @throws SystemException if a system exception occurred
054            */
055            public com.liferay.portlet.expando.model.ExpandoColumn addExpandoColumn(
056                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
057                    throws com.liferay.portal.kernel.exception.SystemException;
058    
059            /**
060            * Creates a new expando column with the primary key. Does not add the expando column to the database.
061            *
062            * @param columnId the primary key for the new expando column
063            * @return the new expando column
064            */
065            public com.liferay.portlet.expando.model.ExpandoColumn createExpandoColumn(
066                    long columnId);
067    
068            /**
069            * Deletes the expando column with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param columnId the primary key of the expando column
072            * @return the expando column that was removed
073            * @throws PortalException if a expando column with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public com.liferay.portlet.expando.model.ExpandoColumn deleteExpandoColumn(
077                    long columnId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException;
080    
081            /**
082            * Deletes the expando column from the database. Also notifies the appropriate model listeners.
083            *
084            * @param expandoColumn the expando column
085            * @return the expando column that was removed
086            * @throws SystemException if a system exception occurred
087            */
088            public com.liferay.portlet.expando.model.ExpandoColumn deleteExpandoColumn(
089                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
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.
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.
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.ExpandoColumn fetchExpandoColumn(
158                    long columnId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            /**
162            * Returns the expando column with the primary key.
163            *
164            * @param columnId the primary key of the expando column
165            * @return the expando column
166            * @throws PortalException if a expando column with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.expando.model.ExpandoColumn getExpandoColumn(
171                    long columnId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException;
180    
181            /**
182            * Returns a range of all the expando columns.
183            *
184            * <p>
185            * 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.
186            * </p>
187            *
188            * @param start the lower bound of the range of expando columns
189            * @param end the upper bound of the range of expando columns (not inclusive)
190            * @return the range of expando columns
191            * @throws SystemException if a system exception occurred
192            */
193            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
194            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getExpandoColumns(
195                    int start, int end)
196                    throws com.liferay.portal.kernel.exception.SystemException;
197    
198            /**
199            * Returns the number of expando columns.
200            *
201            * @return the number of expando columns
202            * @throws SystemException if a system exception occurred
203            */
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public int getExpandoColumnsCount()
206                    throws com.liferay.portal.kernel.exception.SystemException;
207    
208            /**
209            * Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
210            *
211            * @param expandoColumn the expando column
212            * @return the expando column that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.expando.model.ExpandoColumn updateExpandoColumn(
216                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn)
217                    throws com.liferay.portal.kernel.exception.SystemException;
218    
219            /**
220            * Updates the expando column in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
221            *
222            * @param expandoColumn the expando column
223            * @param merge whether to merge the expando column 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.
224            * @return the expando column that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public com.liferay.portlet.expando.model.ExpandoColumn updateExpandoColumn(
228                    com.liferay.portlet.expando.model.ExpandoColumn expandoColumn,
229                    boolean merge)
230                    throws com.liferay.portal.kernel.exception.SystemException;
231    
232            /**
233            * Returns the Spring bean ID for this bean.
234            *
235            * @return the Spring bean ID for this bean
236            */
237            public java.lang.String getBeanIdentifier();
238    
239            /**
240            * Sets the Spring bean ID for this bean.
241            *
242            * @param beanIdentifier the Spring bean ID for this bean
243            */
244            public void setBeanIdentifier(java.lang.String beanIdentifier);
245    
246            public com.liferay.portlet.expando.model.ExpandoColumn addColumn(
247                    long tableId, java.lang.String name, int type)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException;
250    
251            public com.liferay.portlet.expando.model.ExpandoColumn addColumn(
252                    long tableId, java.lang.String name, int type,
253                    java.lang.Object defaultData)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException;
256    
257            public void deleteColumn(
258                    com.liferay.portlet.expando.model.ExpandoColumn column)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            public void deleteColumn(long columnId)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException;
264    
265            public void deleteColumn(long companyId, long classNameId,
266                    java.lang.String tableName, java.lang.String name)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void deleteColumn(long tableId, java.lang.String name)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            public void deleteColumn(long companyId, java.lang.String className,
274                    java.lang.String tableName, java.lang.String name)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException;
277    
278            public void deleteColumns(long tableId)
279                    throws com.liferay.portal.kernel.exception.SystemException;
280    
281            public void deleteColumns(long companyId, long classNameId,
282                    java.lang.String tableName)
283                    throws com.liferay.portal.kernel.exception.PortalException,
284                            com.liferay.portal.kernel.exception.SystemException;
285    
286            public void deleteColumns(long companyId, java.lang.String className,
287                    java.lang.String tableName)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
292            public com.liferay.portlet.expando.model.ExpandoColumn getColumn(
293                    long columnId)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException;
296    
297            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
298            public com.liferay.portlet.expando.model.ExpandoColumn getColumn(
299                    long companyId, long classNameId, java.lang.String tableName,
300                    java.lang.String name)
301                    throws com.liferay.portal.kernel.exception.SystemException;
302    
303            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
304            public com.liferay.portlet.expando.model.ExpandoColumn getColumn(
305                    long tableId, java.lang.String name)
306                    throws com.liferay.portal.kernel.exception.SystemException;
307    
308            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
309            public com.liferay.portlet.expando.model.ExpandoColumn getColumn(
310                    long companyId, java.lang.String className, java.lang.String tableName,
311                    java.lang.String name)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
315            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
316                    long tableId)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
321                    long tableId, java.util.Collection<java.lang.String> names)
322                    throws com.liferay.portal.kernel.exception.SystemException;
323    
324            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
325            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
326                    long companyId, long classNameId, java.lang.String tableName)
327                    throws com.liferay.portal.kernel.exception.SystemException;
328    
329            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
330            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
331                    long companyId, long classNameId, java.lang.String tableName,
332                    java.util.Collection<java.lang.String> names)
333                    throws com.liferay.portal.kernel.exception.SystemException;
334    
335            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
336            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
337                    long companyId, java.lang.String className, java.lang.String tableName)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getColumns(
342                    long companyId, java.lang.String className, java.lang.String tableName,
343                    java.util.Collection<java.lang.String> columnNames)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public int getColumnsCount(long tableId)
348                    throws com.liferay.portal.kernel.exception.SystemException;
349    
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public int getColumnsCount(long companyId, long classNameId,
352                    java.lang.String tableName)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public int getColumnsCount(long companyId, java.lang.String className,
357                    java.lang.String tableName)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
361            public com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
362                    long companyId, long classNameId, java.lang.String name)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public com.liferay.portlet.expando.model.ExpandoColumn getDefaultTableColumn(
367                    long companyId, java.lang.String className, java.lang.String name)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
371            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
372                    long companyId, long classNameId)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
376            public java.util.List<com.liferay.portlet.expando.model.ExpandoColumn> getDefaultTableColumns(
377                    long companyId, java.lang.String className)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
381            public int getDefaultTableColumnsCount(long companyId, long classNameId)
382                    throws com.liferay.portal.kernel.exception.SystemException;
383    
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public int getDefaultTableColumnsCount(long companyId,
386                    java.lang.String className)
387                    throws com.liferay.portal.kernel.exception.SystemException;
388    
389            public com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
390                    long columnId, java.lang.String name, int type)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException;
393    
394            public com.liferay.portlet.expando.model.ExpandoColumn updateColumn(
395                    long columnId, java.lang.String name, int type,
396                    java.lang.Object defaultData)
397                    throws com.liferay.portal.kernel.exception.PortalException,
398                            com.liferay.portal.kernel.exception.SystemException;
399    
400            public com.liferay.portlet.expando.model.ExpandoColumn updateTypeSettings(
401                    long columnId, java.lang.String typeSettings)
402                    throws com.liferay.portal.kernel.exception.PortalException,
403                            com.liferay.portal.kernel.exception.SystemException;
404    }