001
014
015 package com.liferay.portlet.wiki.service;
016
017 import aQute.bnd.annotation.ProviderType;
018
019 import com.liferay.portal.kernel.exception.PortalException;
020 import com.liferay.portal.kernel.exception.SystemException;
021 import com.liferay.portal.kernel.jsonwebservice.JSONWebService;
022 import com.liferay.portal.kernel.transaction.Isolation;
023 import com.liferay.portal.kernel.transaction.Propagation;
024 import com.liferay.portal.kernel.transaction.Transactional;
025 import com.liferay.portal.security.ac.AccessControlled;
026 import com.liferay.portal.service.BaseService;
027
028
039 @AccessControlled
040 @JSONWebService
041 @ProviderType
042 @Transactional(isolation = Isolation.PORTAL, rollbackFor = {
043 PortalException.class, SystemException.class})
044 public interface WikiPageService extends BaseService {
045
050 public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
051 java.lang.String title, java.lang.String content,
052 java.lang.String summary, boolean minorEdit, java.lang.String format,
053 java.lang.String parentTitle, java.lang.String redirectTitle,
054 com.liferay.portal.service.ServiceContext serviceContext)
055 throws com.liferay.portal.kernel.exception.PortalException;
056
057 public com.liferay.portlet.wiki.model.WikiPage addPage(long nodeId,
058 java.lang.String title, java.lang.String content,
059 java.lang.String summary, boolean minorEdit,
060 com.liferay.portal.service.ServiceContext serviceContext)
061 throws com.liferay.portal.kernel.exception.PortalException;
062
063 public void addPageAttachment(long nodeId, java.lang.String title,
064 java.lang.String fileName, java.io.File file, java.lang.String mimeType)
065 throws com.liferay.portal.kernel.exception.PortalException;
066
067 public void addPageAttachment(long nodeId, java.lang.String title,
068 java.lang.String fileName, java.io.InputStream inputStream,
069 java.lang.String mimeType)
070 throws com.liferay.portal.kernel.exception.PortalException;
071
072 public void addPageAttachments(long nodeId, java.lang.String title,
073 java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String, java.io.InputStream>> inputStreamOVPs)
074 throws com.liferay.portal.kernel.exception.PortalException;
075
076 public void addTempFileEntry(long nodeId, java.lang.String folderName,
077 java.lang.String fileName, java.io.InputStream inputStream,
078 java.lang.String mimeType)
079 throws com.liferay.portal.kernel.exception.PortalException;
080
081
085 @java.lang.Deprecated
086 public void addTempPageAttachment(long nodeId, java.lang.String fileName,
087 java.lang.String tempFolderName, java.io.InputStream inputStream,
088 java.lang.String mimeType)
089 throws com.liferay.portal.kernel.exception.PortalException;
090
091 public void changeNode(long nodeId, java.lang.String title, long newNodeId,
092 com.liferay.portal.service.ServiceContext serviceContext)
093 throws com.liferay.portal.kernel.exception.PortalException;
094
095 public void changeParent(long nodeId, java.lang.String title,
096 java.lang.String newParentTitle,
097 com.liferay.portal.service.ServiceContext serviceContext)
098 throws com.liferay.portal.kernel.exception.PortalException;
099
100 public void copyPageAttachments(long templateNodeId,
101 java.lang.String templateTitle, long nodeId, java.lang.String title)
102 throws com.liferay.portal.kernel.exception.PortalException;
103
104 public void deletePage(long nodeId, java.lang.String title)
105 throws com.liferay.portal.kernel.exception.PortalException;
106
107
111 @java.lang.Deprecated
112 public void deletePage(long nodeId, java.lang.String title, double version)
113 throws com.liferay.portal.kernel.exception.PortalException;
114
115 public void deletePageAttachment(long nodeId, java.lang.String title,
116 java.lang.String fileName)
117 throws com.liferay.portal.kernel.exception.PortalException;
118
119 public void deletePageAttachments(long nodeId, java.lang.String title)
120 throws com.liferay.portal.kernel.exception.PortalException;
121
122 public void deleteTempFileEntry(long nodeId, java.lang.String folderName,
123 java.lang.String fileName)
124 throws com.liferay.portal.kernel.exception.PortalException;
125
126 public void deleteTrashPageAttachments(long nodeId, java.lang.String title)
127 throws com.liferay.portal.kernel.exception.PortalException;
128
129 public void discardDraft(long nodeId, java.lang.String title, double version)
130 throws com.liferay.portal.kernel.exception.PortalException;
131
132 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133 public com.liferay.portlet.wiki.model.WikiPage fetchPage(long nodeId,
134 java.lang.String title, double version)
135 throws com.liferay.portal.kernel.exception.PortalException;
136
137
142 public java.lang.String getBeanIdentifier();
143
144 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145 public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getChildren(
146 long groupId, long nodeId, boolean head, java.lang.String parentTitle)
147 throws com.liferay.portal.kernel.exception.PortalException;
148
149 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150 public com.liferay.portlet.wiki.model.WikiPage getDraftPage(long nodeId,
151 java.lang.String title)
152 throws com.liferay.portal.kernel.exception.PortalException;
153
154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155 public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getNodePages(
156 long nodeId, int max)
157 throws com.liferay.portal.kernel.exception.PortalException;
158
159
163 @java.lang.Deprecated
164 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
165 public java.lang.String getNodePagesRSS(long nodeId, int max,
166 java.lang.String type, double version, java.lang.String displayStyle,
167 java.lang.String feedURL, java.lang.String entryURL)
168 throws com.liferay.portal.kernel.exception.PortalException;
169
170 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171 public java.lang.String getNodePagesRSS(long nodeId, int max,
172 java.lang.String type, double version, java.lang.String displayStyle,
173 java.lang.String feedURL, java.lang.String entryURL,
174 java.lang.String attachmentURLPrefix)
175 throws com.liferay.portal.kernel.exception.PortalException;
176
177 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178 public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getOrphans(
179 long groupId, long nodeId)
180 throws com.liferay.portal.kernel.exception.PortalException;
181
182 public com.liferay.portlet.wiki.model.WikiPage getPage(long groupId,
183 long nodeId, java.lang.String title)
184 throws com.liferay.portal.kernel.exception.PortalException;
185
186 public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
187 java.lang.String title)
188 throws com.liferay.portal.kernel.exception.PortalException;
189
190 public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
191 java.lang.String title, java.lang.Boolean head)
192 throws com.liferay.portal.kernel.exception.PortalException;
193
194 public com.liferay.portlet.wiki.model.WikiPage getPage(long nodeId,
195 java.lang.String title, double version)
196 throws com.liferay.portal.kernel.exception.PortalException;
197
198 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199 public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
200 long groupId, long nodeId, boolean head, int status, int start,
201 int end,
202 com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portlet.wiki.model.WikiPage> obc)
203 throws com.liferay.portal.kernel.exception.PortalException;
204
205 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206 public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getPages(
207 long groupId, long userId, long nodeId, int status, int start, int end)
208 throws com.liferay.portal.kernel.exception.PortalException;
209
210 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
211 public int getPagesCount(long groupId, long nodeId, boolean head)
212 throws com.liferay.portal.kernel.exception.PortalException;
213
214 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
215 public int getPagesCount(long groupId, long userId, long nodeId, int status)
216 throws com.liferay.portal.kernel.exception.PortalException;
217
218 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219 public java.lang.String getPagesRSS(long companyId, long nodeId,
220 java.lang.String title, int max, java.lang.String type, double version,
221 java.lang.String displayStyle, java.lang.String feedURL,
222 java.lang.String entryURL, java.lang.String attachmentURLPrefix,
223 java.util.Locale locale)
224 throws com.liferay.portal.kernel.exception.PortalException;
225
226
231 @java.lang.Deprecated
232 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233 public java.lang.String getPagesRSS(long companyId, long nodeId,
234 java.lang.String title, int max, java.lang.String type, double version,
235 java.lang.String displayStyle, java.lang.String feedURL,
236 java.lang.String entryURL, java.util.Locale locale)
237 throws com.liferay.portal.kernel.exception.PortalException;
238
239 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
240 public java.util.List<com.liferay.portlet.wiki.model.WikiPage> getRecentChanges(
241 long groupId, long nodeId, int start, int end)
242 throws com.liferay.portal.kernel.exception.PortalException;
243
244 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
245 public int getRecentChangesCount(long groupId, long nodeId)
246 throws com.liferay.portal.kernel.exception.PortalException;
247
248 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
249 public java.lang.String[] getTempFileNames(long nodeId,
250 java.lang.String folderName)
251 throws com.liferay.portal.kernel.exception.PortalException;
252
253
257 @java.lang.Deprecated
258 public void movePage(long nodeId, java.lang.String title,
259 java.lang.String newTitle,
260 com.liferay.portal.service.ServiceContext serviceContext)
261 throws com.liferay.portal.kernel.exception.PortalException;
262
263 public com.liferay.portal.kernel.repository.model.FileEntry movePageAttachmentToTrash(
264 long nodeId, java.lang.String title, java.lang.String fileName)
265 throws com.liferay.portal.kernel.exception.PortalException;
266
267 public com.liferay.portlet.wiki.model.WikiPage movePageToTrash(
268 long nodeId, java.lang.String title)
269 throws com.liferay.portal.kernel.exception.PortalException;
270
271 public com.liferay.portlet.wiki.model.WikiPage movePageToTrash(
272 long nodeId, java.lang.String title, double version)
273 throws com.liferay.portal.kernel.exception.PortalException;
274
275 public void renamePage(long nodeId, java.lang.String title,
276 java.lang.String newTitle,
277 com.liferay.portal.service.ServiceContext serviceContext)
278 throws com.liferay.portal.kernel.exception.PortalException;
279
280 public void restorePageAttachmentFromTrash(long nodeId,
281 java.lang.String title, java.lang.String fileName)
282 throws com.liferay.portal.kernel.exception.PortalException;
283
284 public void restorePageFromTrash(long resourcePrimKey)
285 throws com.liferay.portal.kernel.exception.PortalException;
286
287 public com.liferay.portlet.wiki.model.WikiPage revertPage(long nodeId,
288 java.lang.String title, double version,
289 com.liferay.portal.service.ServiceContext serviceContext)
290 throws com.liferay.portal.kernel.exception.PortalException;
291
292
297 public void setBeanIdentifier(java.lang.String beanIdentifier);
298
299 public void subscribePage(long nodeId, java.lang.String title)
300 throws com.liferay.portal.kernel.exception.PortalException;
301
302 public void unsubscribePage(long nodeId, java.lang.String title)
303 throws com.liferay.portal.kernel.exception.PortalException;
304
305 public com.liferay.portlet.wiki.model.WikiPage updatePage(long nodeId,
306 java.lang.String title, double version, java.lang.String content,
307 java.lang.String summary, boolean minorEdit, java.lang.String format,
308 java.lang.String parentTitle, java.lang.String redirectTitle,
309 com.liferay.portal.service.ServiceContext serviceContext)
310 throws com.liferay.portal.kernel.exception.PortalException;
311 }