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.journal.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 journal 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 JournalStructureLocalServiceUtil
033     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
034     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface JournalStructureLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link JournalStructureLocalServiceUtil} to access the journal structure local service. Add custom service methods to {@link com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
048            *
049            * @param journalStructure the journal structure
050            * @return the journal structure that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
054                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
059            *
060            * @param id the primary key for the new journal structure
061            * @return the new journal structure
062            */
063            public com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
064                    long id);
065    
066            /**
067            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param id the primary key of the journal structure
070            * @throws PortalException if a journal structure with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteJournalStructure(long id)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
079            *
080            * @param journalStructure the journal structure
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteJournalStructure(
084                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
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.journal.model.JournalStructure fetchJournalStructure(
151                    long id) throws com.liferay.portal.kernel.exception.SystemException;
152    
153            /**
154            * Returns the journal structure with the primary key.
155            *
156            * @param id the primary key of the journal structure
157            * @return the journal structure
158            * @throws PortalException if a journal structure with the primary key could not be found
159            * @throws SystemException if a system exception occurred
160            */
161            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162            public com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
163                    long id)
164                    throws com.liferay.portal.kernel.exception.PortalException,
165                            com.liferay.portal.kernel.exception.SystemException;
166    
167            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
168            public com.liferay.portal.model.PersistedModel getPersistedModel(
169                    java.io.Serializable primaryKeyObj)
170                    throws com.liferay.portal.kernel.exception.PortalException,
171                            com.liferay.portal.kernel.exception.SystemException;
172    
173            /**
174            * Returns the journal structure with the UUID in the group.
175            *
176            * @param uuid the UUID of journal structure
177            * @param groupId the group id of the journal structure
178            * @return the journal structure
179            * @throws PortalException if a journal structure with the UUID in the group could not be found
180            * @throws SystemException if a system exception occurred
181            */
182            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
183            public com.liferay.portlet.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
184                    java.lang.String uuid, long groupId)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException;
187    
188            /**
189            * Returns a range of all the journal structures.
190            *
191            * <p>
192            * 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.
193            * </p>
194            *
195            * @param start the lower bound of the range of journal structures
196            * @param end the upper bound of the range of journal structures (not inclusive)
197            * @return the range of journal structures
198            * @throws SystemException if a system exception occurred
199            */
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException;
204    
205            /**
206            * Returns the number of journal structures.
207            *
208            * @return the number of journal structures
209            * @throws SystemException if a system exception occurred
210            */
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public int getJournalStructuresCount()
213                    throws com.liferay.portal.kernel.exception.SystemException;
214    
215            /**
216            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
217            *
218            * @param journalStructure the journal structure
219            * @return the journal structure that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
223                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            /**
227            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
228            *
229            * @param journalStructure the journal structure
230            * @param merge whether to merge the journal 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.
231            * @return the journal structure that was updated
232            * @throws SystemException if a system exception occurred
233            */
234            public com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
235                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
236                    boolean merge)
237                    throws com.liferay.portal.kernel.exception.SystemException;
238    
239            /**
240            * Returns the Spring bean ID for this bean.
241            *
242            * @return the Spring bean ID for this bean
243            */
244            public java.lang.String getBeanIdentifier();
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public void setBeanIdentifier(java.lang.String beanIdentifier);
252    
253            public com.liferay.portlet.journal.model.JournalStructure addStructure(
254                    long userId, long groupId, java.lang.String structureId,
255                    boolean autoStructureId, java.lang.String parentStructureId,
256                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
257                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
258                    java.lang.String xsd,
259                    com.liferay.portal.service.ServiceContext serviceContext)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException;
262    
263            public void addStructureResources(
264                    com.liferay.portlet.journal.model.JournalStructure structure,
265                    boolean addGroupPermissions, boolean addGuestPermissions)
266                    throws com.liferay.portal.kernel.exception.PortalException,
267                            com.liferay.portal.kernel.exception.SystemException;
268    
269            public void addStructureResources(
270                    com.liferay.portlet.journal.model.JournalStructure structure,
271                    java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException;
274    
275            public void addStructureResources(long groupId,
276                    java.lang.String structureId, boolean addGroupPermissions,
277                    boolean addGuestPermissions)
278                    throws com.liferay.portal.kernel.exception.PortalException,
279                            com.liferay.portal.kernel.exception.SystemException;
280    
281            public void addStructureResources(long groupId,
282                    java.lang.String structureId, java.lang.String[] groupPermissions,
283                    java.lang.String[] guestPermissions)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException;
286    
287            public void checkNewLine(long groupId, java.lang.String structureId)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException;
290    
291            public com.liferay.portlet.journal.model.JournalStructure copyStructure(
292                    long userId, long groupId, java.lang.String oldStructureId,
293                    java.lang.String newStructureId, boolean autoStructureId)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException;
296    
297            public void deleteStructure(
298                    com.liferay.portlet.journal.model.JournalStructure structure)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            public void deleteStructure(long groupId, java.lang.String structureId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException;
305    
306            public void deleteStructures(long groupId)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException;
309    
310            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
311            public com.liferay.portlet.journal.model.JournalStructure getStructure(
312                    long id)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public com.liferay.portlet.journal.model.JournalStructure getStructure(
318                    long groupId, java.lang.String structureId)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
327            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
328                    long groupId)
329                    throws com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
333                    long groupId, int start, int end)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public int getStructuresCount(long groupId)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
342                    long companyId, long[] groupIds, java.lang.String keywords, int start,
343                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
344                    throws com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
348                    long companyId, long[] groupIds, java.lang.String structureId,
349                    java.lang.String name, java.lang.String description,
350                    boolean andOperator, int start, int end,
351                    com.liferay.portal.kernel.util.OrderByComparator obc)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
355            public int searchCount(long companyId, long[] groupIds,
356                    java.lang.String keywords)
357                    throws com.liferay.portal.kernel.exception.SystemException;
358    
359            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
360            public int searchCount(long companyId, long[] groupIds,
361                    java.lang.String structureId, java.lang.String name,
362                    java.lang.String description, boolean andOperator)
363                    throws com.liferay.portal.kernel.exception.SystemException;
364    
365            public com.liferay.portlet.journal.model.JournalStructure updateStructure(
366                    long groupId, java.lang.String structureId,
367                    java.lang.String parentStructureId,
368                    java.util.Map<java.util.Locale, java.lang.String> nameMap,
369                    java.util.Map<java.util.Locale, java.lang.String> descriptionMap,
370                    java.lang.String xsd,
371                    com.liferay.portal.service.ServiceContext serviceContext)
372                    throws com.liferay.portal.kernel.exception.PortalException,
373                            com.liferay.portal.kernel.exception.SystemException;
374    }