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.dynamicdatamapping.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 d d m structure 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 DDMStructureLocalServiceUtil
033     * @see com.liferay.portlet.dynamicdatamapping.service.base.DDMStructureLocalServiceBaseImpl
034     * @see com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface DDMStructureLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link DDMStructureLocalServiceUtil} to access the d d m structure local service. Add custom service methods to {@link com.liferay.portlet.dynamicdatamapping.service.impl.DDMStructureLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the d d m structure to the database. Also notifies the appropriate model listeners.
048            *
049            * @param ddmStructure the d d m structure
050            * @return the d d m structure that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addDDMStructure(
054                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new d d m structure with the primary key. Does not add the d d m structure to the database.
059            *
060            * @param structureId the primary key for the new d d m structure
061            * @return the new d d m structure
062            */
063            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure createDDMStructure(
064                    long structureId);
065    
066            /**
067            * Deletes the d d m structure with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param structureId the primary key of the d d m structure
070            * @throws PortalException if a d d m structure with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteDDMStructure(long structureId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the d d m structure from the database. Also notifies the appropriate model listeners.
079            *
080            * @param ddmStructure the d d m structure
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteDDMStructure(
084                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
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.dynamicdatamapping.model.DDMStructure fetchDDMStructure(
151                    long structureId)
152                    throws com.liferay.portal.kernel.exception.SystemException;
153    
154            /**
155            * Returns the d d m structure with the primary key.
156            *
157            * @param structureId the primary key of the d d m structure
158            * @return the d d m structure
159            * @throws PortalException if a d d m structure 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.dynamicdatamapping.model.DDMStructure getDDMStructure(
164                    long structureId)
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 the d d m structure with the UUID in the group.
176            *
177            * @param uuid the UUID of d d m structure
178            * @param groupId the group id of the d d m structure
179            * @return the d d m structure
180            * @throws PortalException if a d d m structure with the UUID in the group could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getDDMStructureByUuidAndGroupId(
185                    java.lang.String uuid, long groupId)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException;
188    
189            /**
190            * Returns a range of all the d d m structures.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of d d m structures
197            * @param end the upper bound of the range of d d m structures (not inclusive)
198            * @return the range of d d m structures
199            * @throws SystemException if a system exception occurred
200            */
201            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
202            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDDMStructures(
203                    int start, int end)
204                    throws com.liferay.portal.kernel.exception.SystemException;
205    
206            /**
207            * Returns the number of d d m structures.
208            *
209            * @return the number of d d m structures
210            * @throws SystemException if a system exception occurred
211            */
212            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
213            public int getDDMStructuresCount()
214                    throws com.liferay.portal.kernel.exception.SystemException;
215    
216            /**
217            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
218            *
219            * @param ddmStructure the d d m structure
220            * @return the d d m structure that was updated
221            * @throws SystemException if a system exception occurred
222            */
223            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
224                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure)
225                    throws com.liferay.portal.kernel.exception.SystemException;
226    
227            /**
228            * Updates the d d m structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param ddmStructure the d d m structure
231            * @param merge whether to merge the d d m structure 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.
232            * @return the d d m structure that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateDDMStructure(
236                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure ddmStructure,
237                    boolean merge)
238                    throws com.liferay.portal.kernel.exception.SystemException;
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public java.lang.String getBeanIdentifier();
246    
247            /**
248            * Sets the Spring bean ID for this bean.
249            *
250            * @param beanIdentifier the Spring bean ID for this bean
251            */
252            public void setBeanIdentifier(java.lang.String beanIdentifier);
253    
254            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure addStructure(
255                    long userId, long groupId, long classNameId,
256                    java.lang.String structureKey,
257                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
258                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
259                    java.lang.String xsd, java.lang.String storageType, int type,
260                    com.liferay.portal.service.ServiceContext serviceContext)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public void addStructureResources(
265                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
266                    boolean addGroupPermissions, boolean addGuestPermissions)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void addStructureResources(
271                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure,
272                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
273                    throws com.liferay.portal.kernel.exception.PortalException,
274                            com.liferay.portal.kernel.exception.SystemException;
275    
276            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure copyStructure(
277                    long userId, long structureId,
278                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
279                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
280                    com.liferay.portal.service.ServiceContext serviceContext)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException;
283    
284            public void deleteStructure(
285                    com.liferay.portlet.dynamicdatamapping.model.DDMStructure structure)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            public void deleteStructure(long structureId)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException;
292    
293            public void deleteStructure(long groupId, java.lang.String structureKey)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException;
296    
297            public void deleteStructures(long groupId)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException;
300    
301            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
302            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
303                    long structureId)
304                    throws com.liferay.portal.kernel.exception.SystemException;
305    
306            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure fetchStructure(
308                    long groupId, java.lang.String structureKey)
309                    throws com.liferay.portal.kernel.exception.SystemException;
310    
311            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
312            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
313                    long classNameId)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
318                    long classNameId, int start, int end)
319                    throws com.liferay.portal.kernel.exception.SystemException;
320    
321            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
322            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getClassStructures(
323                    long classNameId,
324                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getDLFileEntryTypeStructures(
329                    long dlFileEntryTypeId)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
334                    long structureId)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException;
337    
338            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
339            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure getStructure(
340                    long groupId, java.lang.String structureKey)
341                    throws com.liferay.portal.kernel.exception.PortalException,
342                            com.liferay.portal.kernel.exception.SystemException;
343    
344            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
345            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructure(
346                    long groupId, java.lang.String name, java.lang.String description)
347                    throws com.liferay.portal.kernel.exception.SystemException;
348    
349            /**
350            * @deprecated {@link #getStructures}
351            */
352            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
353            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries()
354                    throws com.liferay.portal.kernel.exception.SystemException;
355    
356            /**
357            * @deprecated {@link #getStructures(long)}
358            */
359            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
360            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
361                    long groupId)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            /**
365            * @deprecated {@link #getStructures(long, int, int)}
366            */
367            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
368            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructureEntries(
369                    long groupId, int start, int end)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
373            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures()
374                    throws com.liferay.portal.kernel.exception.SystemException;
375    
376            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
377            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
378                    long groupId)
379                    throws com.liferay.portal.kernel.exception.SystemException;
380    
381            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
382            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> getStructures(
383                    long groupId, int start, int end)
384                    throws com.liferay.portal.kernel.exception.SystemException;
385    
386            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
387            public int getStructuresCount(long groupId)
388                    throws com.liferay.portal.kernel.exception.SystemException;
389    
390            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
391            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
392                    long companyId, long[] groupIds, long[] classNameIds,
393                    java.lang.String keywords, int start, int end,
394                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
395                    throws com.liferay.portal.kernel.exception.SystemException;
396    
397            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
398            public java.util.List<com.liferay.portlet.dynamicdatamapping.model.DDMStructure> search(
399                    long companyId, long[] groupIds, long[] classNameIds,
400                    java.lang.String name, java.lang.String description,
401                    java.lang.String storageType, int type, boolean andOperator, int start,
402                    int end,
403                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
404                    throws com.liferay.portal.kernel.exception.SystemException;
405    
406            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
407            public int searchCount(long companyId, long[] groupIds,
408                    long[] classNameIds, java.lang.String keywords)
409                    throws com.liferay.portal.kernel.exception.SystemException;
410    
411            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
412            public int searchCount(long companyId, long[] groupIds,
413                    long[] classNameIds, java.lang.String name,
414                    java.lang.String description, java.lang.String storageType, int type,
415                    boolean andOperator)
416                    throws com.liferay.portal.kernel.exception.SystemException;
417    
418            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
419                    long structureId,
420                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
421                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
422                    java.lang.String xsd,
423                    com.liferay.portal.service.ServiceContext serviceContext)
424                    throws com.liferay.portal.kernel.exception.PortalException,
425                            com.liferay.portal.kernel.exception.SystemException;
426    
427            public com.liferay.portlet.dynamicdatamapping.model.DDMStructure updateStructure(
428                    long groupId, java.lang.String structureKey,
429                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
430                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
431                    java.lang.String xsd,
432                    com.liferay.portal.service.ServiceContext serviceContext)
433                    throws com.liferay.portal.kernel.exception.PortalException,
434                            com.liferay.portal.kernel.exception.SystemException;
435    }