001    /**
002     * Copyright (c) 2000-2010 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.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the journal structure local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see JournalStructureLocalServiceUtil
036     * @see com.liferay.portlet.journal.service.base.JournalStructureLocalServiceBaseImpl
037     * @see com.liferay.portlet.journal.service.impl.JournalStructureLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface JournalStructureLocalService {
043            /**
044            * Adds the journal structure to the database. Also notifies the appropriate model listeners.
045            *
046            * @param journalStructure the journal structure to add
047            * @return the journal structure that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portlet.journal.model.JournalStructure addJournalStructure(
051                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new journal structure with the primary key. Does not add the journal structure to the database.
056            *
057            * @param id the primary key for the new journal structure
058            * @return the new journal structure
059            */
060            public com.liferay.portlet.journal.model.JournalStructure createJournalStructure(
061                    long id);
062    
063            /**
064            * Deletes the journal structure with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param id the primary key of the journal structure to delete
067            * @throws PortalException if a journal structure with the primary key could not be found
068            * @throws SystemException if a system exception occurred
069            */
070            public void deleteJournalStructure(long id)
071                    throws com.liferay.portal.kernel.exception.PortalException,
072                            com.liferay.portal.kernel.exception.SystemException;
073    
074            /**
075            * Deletes the journal structure from the database. Also notifies the appropriate model listeners.
076            *
077            * @param journalStructure the journal structure to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public void deleteJournalStructure(
081                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException;
095    
096            /**
097            * Performs a dynamic query on the database and returns a range of the matching rows.
098            *
099            * <p>
100            * 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.
101            * </p>
102            *
103            * @param dynamicQuery the dynamic query to search with
104            * @param start the lower bound of the range of model instances to return
105            * @param end the upper bound of the range of model instances to return (not inclusive)
106            * @return the range of matching rows
107            * @throws SystemException if a system exception occurred
108            */
109            @SuppressWarnings("rawtypes")
110            public java.util.List dynamicQuery(
111                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
112                    int end) throws com.liferay.portal.kernel.exception.SystemException;
113    
114            /**
115            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
116            *
117            * <p>
118            * 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.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query to search with
122            * @param start the lower bound of the range of model instances to return
123            * @param end the upper bound of the range of model instances to return (not inclusive)
124            * @param orderByComparator the comparator to order the results by
125            * @return the ordered range of matching rows
126            * @throws SystemException if a system exception occurred
127            */
128            @SuppressWarnings("rawtypes")
129            public java.util.List dynamicQuery(
130                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
131                    int end,
132                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
133                    throws com.liferay.portal.kernel.exception.SystemException;
134    
135            /**
136            * Counts the number of rows that match the dynamic query.
137            *
138            * @param dynamicQuery the dynamic query to search with
139            * @return the number of rows that match the dynamic query
140            * @throws SystemException if a system exception occurred
141            */
142            public long dynamicQueryCount(
143                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
144                    throws com.liferay.portal.kernel.exception.SystemException;
145    
146            /**
147            * Gets the journal structure with the primary key.
148            *
149            * @param id the primary key of the journal structure to get
150            * @return the journal structure
151            * @throws PortalException if a journal structure with the primary key could not be found
152            * @throws SystemException if a system exception occurred
153            */
154            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155            public com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
156                    long id)
157                    throws com.liferay.portal.kernel.exception.PortalException,
158                            com.liferay.portal.kernel.exception.SystemException;
159    
160            /**
161            * Gets the journal structure with the UUID and group id.
162            *
163            * @param uuid the UUID of journal structure to get
164            * @param groupId the group id of the journal structure to get
165            * @return the journal structure
166            * @throws PortalException if a journal structure with the UUID and group id 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.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
171                    java.lang.String uuid, long groupId)
172                    throws com.liferay.portal.kernel.exception.PortalException,
173                            com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Gets a range of all the journal structures.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of journal structures to return
183            * @param end the upper bound of the range of journal structures to return (not inclusive)
184            * @return the range of journal structures
185            * @throws SystemException if a system exception occurred
186            */
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
189                    int start, int end)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Gets the number of journal structures.
194            *
195            * @return the number of journal structures
196            * @throws SystemException if a system exception occurred
197            */
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public int getJournalStructuresCount()
200                    throws com.liferay.portal.kernel.exception.SystemException;
201    
202            /**
203            * Updates the journal structure in the database. Also notifies the appropriate model listeners.
204            *
205            * @param journalStructure the journal structure to update
206            * @return the journal structure that was updated
207            * @throws SystemException if a system exception occurred
208            */
209            public com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
210                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Updates the journal structure in the database. Also notifies the appropriate model listeners.
215            *
216            * @param journalStructure the journal structure to update
217            * @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.
218            * @return the journal structure that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
222                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
223                    boolean merge)
224                    throws com.liferay.portal.kernel.exception.SystemException;
225    
226            public com.liferay.portlet.journal.model.JournalStructure addStructure(
227                    long userId, long groupId, java.lang.String structureId,
228                    boolean autoStructureId, java.lang.String parentStructureId,
229                    java.lang.String name, java.lang.String description,
230                    java.lang.String xsd,
231                    com.liferay.portal.service.ServiceContext serviceContext)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException;
234    
235            public void addStructureResources(long groupId,
236                    java.lang.String structureId, boolean addCommunityPermissions,
237                    boolean addGuestPermissions)
238                    throws com.liferay.portal.kernel.exception.PortalException,
239                            com.liferay.portal.kernel.exception.SystemException;
240    
241            public void addStructureResources(
242                    com.liferay.portlet.journal.model.JournalStructure structure,
243                    boolean addCommunityPermissions, boolean addGuestPermissions)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public void addStructureResources(long groupId,
248                    java.lang.String structureId, java.lang.String[] communityPermissions,
249                    java.lang.String[] guestPermissions)
250                    throws com.liferay.portal.kernel.exception.PortalException,
251                            com.liferay.portal.kernel.exception.SystemException;
252    
253            public void addStructureResources(
254                    com.liferay.portlet.journal.model.JournalStructure structure,
255                    java.lang.String[] communityPermissions,
256                    java.lang.String[] guestPermissions)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void checkNewLine(long groupId, java.lang.String structureId)
261                    throws com.liferay.portal.kernel.exception.PortalException,
262                            com.liferay.portal.kernel.exception.SystemException;
263    
264            public com.liferay.portlet.journal.model.JournalStructure copyStructure(
265                    long userId, long groupId, java.lang.String oldStructureId,
266                    java.lang.String newStructureId, boolean autoStructureId)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void deleteStructure(long groupId, java.lang.String structureId)
271                    throws com.liferay.portal.kernel.exception.PortalException,
272                            com.liferay.portal.kernel.exception.SystemException;
273    
274            public void deleteStructure(
275                    com.liferay.portlet.journal.model.JournalStructure structure)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException;
278    
279            public void deleteStructures(long groupId)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public com.liferay.portlet.journal.model.JournalStructure getStructure(
285                    long id)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException;
288    
289            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
290            public com.liferay.portlet.journal.model.JournalStructure getStructure(
291                    long groupId, java.lang.String structureId)
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 java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
297                    throws com.liferay.portal.kernel.exception.SystemException;
298    
299            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
300            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
301                    long groupId)
302                    throws com.liferay.portal.kernel.exception.SystemException;
303    
304            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
305            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
306                    long groupId, int start, int end)
307                    throws com.liferay.portal.kernel.exception.SystemException;
308    
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public int getStructuresCount(long groupId)
311                    throws com.liferay.portal.kernel.exception.SystemException;
312    
313            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
314            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
315                    long companyId, long groupId, java.lang.String keywords, int start,
316                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
317                    throws com.liferay.portal.kernel.exception.SystemException;
318    
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
321                    long companyId, long groupId, java.lang.String structureId,
322                    java.lang.String name, java.lang.String description,
323                    boolean andOperator, int start, int end,
324                    com.liferay.portal.kernel.util.OrderByComparator obc)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public int searchCount(long companyId, long groupId,
329                    java.lang.String keywords)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public int searchCount(long companyId, long groupId,
334                    java.lang.String structureId, java.lang.String name,
335                    java.lang.String description, boolean andOperator)
336                    throws com.liferay.portal.kernel.exception.SystemException;
337    
338            public com.liferay.portlet.journal.model.JournalStructure updateStructure(
339                    long groupId, java.lang.String structureId,
340                    java.lang.String parentStructureId, java.lang.String name,
341                    java.lang.String description, java.lang.String xsd,
342                    com.liferay.portal.service.ServiceContext serviceContext)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    }