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