001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            /**
150            * Returns the journal structure with the primary key.
151            *
152            * @param id the primary key of the journal structure
153            * @return the journal structure
154            * @throws PortalException if a journal structure with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.journal.model.JournalStructure getJournalStructure(
159                    long id)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns the journal structure with the UUID in the group.
171            *
172            * @param uuid the UUID of journal structure
173            * @param groupId the group id of the journal structure
174            * @return the journal structure
175            * @throws PortalException if a journal structure with the UUID in the group could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portlet.journal.model.JournalStructure getJournalStructureByUuidAndGroupId(
180                    java.lang.String uuid, long groupId)
181                    throws com.liferay.portal.kernel.exception.PortalException,
182                            com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Returns a range of all the journal structures.
186            *
187            * <p>
188            * 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.
189            * </p>
190            *
191            * @param start the lower bound of the range of journal structures
192            * @param end the upper bound of the range of journal structures (not inclusive)
193            * @return the range of journal structures
194            * @throws SystemException if a system exception occurred
195            */
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getJournalStructures(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException;
200    
201            /**
202            * Returns the number of journal structures.
203            *
204            * @return the number of journal structures
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public int getJournalStructuresCount()
209                    throws com.liferay.portal.kernel.exception.SystemException;
210    
211            /**
212            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
213            *
214            * @param journalStructure the journal structure
215            * @return the journal structure that was updated
216            * @throws SystemException if a system exception occurred
217            */
218            public com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
219                    com.liferay.portlet.journal.model.JournalStructure journalStructure)
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the journal structure in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param journalStructure the journal structure
226            * @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.
227            * @return the journal structure that was updated
228            * @throws SystemException if a system exception occurred
229            */
230            public com.liferay.portlet.journal.model.JournalStructure updateJournalStructure(
231                    com.liferay.portlet.journal.model.JournalStructure journalStructure,
232                    boolean merge)
233                    throws com.liferay.portal.kernel.exception.SystemException;
234    
235            /**
236            * Returns the Spring bean ID for this bean.
237            *
238            * @return the Spring bean ID for this bean
239            */
240            public java.lang.String getBeanIdentifier();
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public void setBeanIdentifier(java.lang.String beanIdentifier);
248    
249            public com.liferay.portlet.journal.model.JournalStructure addStructure(
250                    long userId, long groupId, java.lang.String structureId,
251                    boolean autoStructureId, java.lang.String parentStructureId,
252                    java.lang.String name, java.lang.String description,
253                    java.lang.String xsd,
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.journal.model.JournalStructure structure,
260                    boolean addCommunityPermissions, 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.journal.model.JournalStructure structure,
266                    java.lang.String[] communityPermissions,
267                    java.lang.String[] guestPermissions)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException;
270    
271            public void addStructureResources(long groupId,
272                    java.lang.String structureId, boolean addCommunityPermissions,
273                    boolean addGuestPermissions)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException;
276    
277            public void addStructureResources(long groupId,
278                    java.lang.String structureId, java.lang.String[] communityPermissions,
279                    java.lang.String[] guestPermissions)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException;
282    
283            public void checkNewLine(long groupId, java.lang.String structureId)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException;
286    
287            public com.liferay.portlet.journal.model.JournalStructure copyStructure(
288                    long userId, long groupId, java.lang.String oldStructureId,
289                    java.lang.String newStructureId, boolean autoStructureId)
290                    throws com.liferay.portal.kernel.exception.PortalException,
291                            com.liferay.portal.kernel.exception.SystemException;
292    
293            public void deleteStructure(
294                    com.liferay.portlet.journal.model.JournalStructure structure)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            public void deleteStructure(long groupId, java.lang.String structureId)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException;
301    
302            public void deleteStructures(long groupId)
303                    throws com.liferay.portal.kernel.exception.PortalException,
304                            com.liferay.portal.kernel.exception.SystemException;
305    
306            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
307            public com.liferay.portlet.journal.model.JournalStructure getStructure(
308                    long id)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public com.liferay.portlet.journal.model.JournalStructure getStructure(
314                    long groupId, java.lang.String structureId)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException;
317    
318            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
319            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures()
320                    throws 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                    long groupId)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> getStructures(
329                    long groupId, int start, int end)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
333            public int getStructuresCount(long groupId)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            /**
337            * @deprecated {@link #search(long, long[], String, int, int,
338            OrderByComparator)}
339            */
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
342                    long companyId, long groupId, 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            /**
347            * @deprecated {@link #search(long, long[], String, String, String, boolean,
348            int, int, OrderByComparator)}
349            */
350            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
351            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
352                    long companyId, long groupId, java.lang.String structureId,
353                    java.lang.String name, java.lang.String description,
354                    boolean andOperator, int start, int end,
355                    com.liferay.portal.kernel.util.OrderByComparator obc)
356                    throws com.liferay.portal.kernel.exception.SystemException;
357    
358            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
359            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
360                    long companyId, long[] groupIds, java.lang.String keywords, int start,
361                    int end, com.liferay.portal.kernel.util.OrderByComparator obc)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
365            public java.util.List<com.liferay.portlet.journal.model.JournalStructure> search(
366                    long companyId, long[] groupIds, java.lang.String structureId,
367                    java.lang.String name, java.lang.String description,
368                    boolean andOperator, int start, int end,
369                    com.liferay.portal.kernel.util.OrderByComparator obc)
370                    throws com.liferay.portal.kernel.exception.SystemException;
371    
372            /**
373            * @deprecated {@link #searchCount(long, long[], String)}
374            */
375            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
376            public int searchCount(long companyId, long groupId,
377                    java.lang.String keywords)
378                    throws com.liferay.portal.kernel.exception.SystemException;
379    
380            /**
381            * @deprecated {@link #searchCount(long, long[], String, String, String,
382            boolean)}
383            */
384            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
385            public int searchCount(long companyId, long groupId,
386                    java.lang.String structureId, java.lang.String name,
387                    java.lang.String description, boolean andOperator)
388                    throws com.liferay.portal.kernel.exception.SystemException;
389    
390            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
391            public int searchCount(long companyId, long[] groupIds,
392                    java.lang.String keywords)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
396            public int searchCount(long companyId, long[] groupIds,
397                    java.lang.String structureId, java.lang.String name,
398                    java.lang.String description, boolean andOperator)
399                    throws com.liferay.portal.kernel.exception.SystemException;
400    
401            public com.liferay.portlet.journal.model.JournalStructure updateStructure(
402                    long groupId, java.lang.String structureId,
403                    java.lang.String parentStructureId, java.lang.String name,
404                    java.lang.String description, java.lang.String xsd,
405                    com.liferay.portal.service.ServiceContext serviceContext)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException;
408    }