1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portlet.wiki.service;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="WikiPageService.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This interface defines the service. The default implementation is
40   * <code>com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl</code>.
41   * Modify methods in that class and rerun ServiceBuilder to populate this class
42   * and all other generated classes.
43   * </p>
44   *
45   * <p>
46   * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portlet.wiki.service.WikiPageServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface WikiPageService {
57      public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
58          java.lang.String title, java.lang.String content,
59          java.lang.String summary, boolean minorEdit,
60          com.liferay.portal.service.ServiceContext serviceContext)
61          throws com.liferay.portal.PortalException,
62              com.liferay.portal.SystemException;
63  
64      public void addPageAttachments(long nodeId, java.lang.String title,
65          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files)
66          throws com.liferay.portal.PortalException,
67              com.liferay.portal.SystemException;
68  
69      public void changeParent(long nodeId, java.lang.String title,
70          java.lang.String newParentTitle,
71          com.liferay.portal.service.ServiceContext serviceContext)
72          throws com.liferay.portal.PortalException,
73              com.liferay.portal.SystemException;
74  
75      public void deletePage(long nodeId, java.lang.String title)
76          throws com.liferay.portal.PortalException,
77              com.liferay.portal.SystemException;
78  
79      public void deletePageAttachment(long nodeId, java.lang.String title,
80          java.lang.String fileName)
81          throws com.liferay.portal.PortalException,
82              com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(
86          long nodeId, int max)
87          throws com.liferay.portal.PortalException,
88              com.liferay.portal.SystemException;
89  
90      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
91      public java.lang.String getNodePagesRSS(long nodeId, int max,
92          java.lang.String type, double version, java.lang.String displayStyle,
93          java.lang.String feedURL, java.lang.String entryURL)
94          throws com.liferay.portal.PortalException,
95              com.liferay.portal.SystemException;
96  
97      public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
98          java.lang.String title)
99          throws com.liferay.portal.PortalException,
100             com.liferay.portal.SystemException;
101 
102     public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
103         java.lang.String title, double version)
104         throws com.liferay.portal.PortalException,
105             com.liferay.portal.SystemException;
106 
107     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
108     public java.lang.String getPagesRSS(long companyId, long nodeId,
109         java.lang.String title, int max, java.lang.String type, double version,
110         java.lang.String displayStyle, java.lang.String feedURL,
111         java.lang.String entryURL, java.util.Locale locale)
112         throws com.liferay.portal.PortalException,
113             com.liferay.portal.SystemException;
114 
115     public void movePage(long nodeId, java.lang.String title,
116         java.lang.String newTitle,
117         com.liferay.portal.service.ServiceContext serviceContext)
118         throws com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException;
120 
121     public com.liferay.portlet.wiki.model.WikiPage revertPage(long nodeId,
122         java.lang.String title, double version,
123         com.liferay.portal.service.ServiceContext serviceContext)
124         throws com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException;
126 
127     public void subscribePage(long nodeId, java.lang.String title)
128         throws com.liferay.portal.PortalException,
129             com.liferay.portal.SystemException;
130 
131     public void unsubscribePage(long nodeId, java.lang.String title)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException;
134 
135     public com.liferay.portlet.wiki.model.WikiPage updatePage(long nodeId,
136         java.lang.String title, double version, java.lang.String content,
137         java.lang.String summary, boolean minorEdit, java.lang.String format,
138         java.lang.String parentTitle, java.lang.String redirectTitle,
139         com.liferay.portal.service.ServiceContext serviceContext)
140         throws com.liferay.portal.PortalException,
141             com.liferay.portal.SystemException;
142 }