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