|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DraftService
A Service responsible for Draft related operations during editing in Confluence.
Nested Class Summary | |
---|---|
static class |
DraftService.DraftType
|
Method Summary | |
---|---|
Draft |
createDraftForEditor(AbstractPage page)
Create and store a draft for the supplied AbstractPage for the current user. |
Draft |
findDraftForEditor(long contentId,
DraftService.DraftType type,
String spaceKey)
Find and return a draft of the specified content Id and type for the current user. |
Draft |
findOrCreateDraftForEditor(String spaceKey,
DraftService.DraftType type)
Find the draft within the identified space for the current user. |
void |
removeDraft(long contentId,
DraftService.DraftType type,
String spaceKey)
Removes the draft specified by the given content id and type for the current user. |
Draft |
saveDraftFromEditor(String title,
DraftService.DraftType type,
String content,
String contentId,
String spaceKey,
int pageVersion)
Create and store a draft for the current user with the supplied details. |
Method Detail |
---|
Draft saveDraftFromEditor(String title, DraftService.DraftType type, String content, String contentId, String spaceKey, int pageVersion) throws NotAuthorizedException, NotValidException
title
- type
- content
- the editor formatted content (will be converted into storage format).contentId
- as a String since NEW is taken to represent a new draftspaceKey
- pageVersion
-
NotAuthorizedException
- if the current user is not able to save a draft (doesn't have edit permission)
NotValidException
- if the data for the draft is incomplete or the content identified does not exist
IllegalArgumentException
- if there is a problem with the arguments suppliedDraft createDraftForEditor(AbstractPage page) throws NotAuthorizedException, NotValidException
page
- the page to create a Draft from
NotAuthorizedException
- if the current user is not able to save a draft (doesn't have edit permission)
NotValidException
- if the data for the draft is incomplete or the content identified does not existDraft findDraftForEditor(long contentId, DraftService.DraftType type, String spaceKey) throws NotAuthorizedException, NotValidException
contentId
- type
- spaceKey
-
NotAuthorizedException
- if the current user is not permitted to view drafts for the identified content
NotValidException
- if the content identified does not exist
IllegalArgumentException
- if there are any problems with the supplied parametersDraft findOrCreateDraftForEditor(String spaceKey, DraftService.DraftType type) throws NotAuthorizedException, NotValidException
spaceKey
- type
-
NotAuthorizedException
- if the current user is not permitted to view or create drafts in the space
NotValidException
- if the space identified does not exist.
IllegalArgumentException
- if the required parameters are not provided.void removeDraft(long contentId, DraftService.DraftType type, String spaceKey) throws NotAuthorizedException, NotValidException
contentId
- type
- spaceKey
- since a new page draft is unique per space the spaceKey must be provided if the contentId is 0
NotAuthorizedException
- if the current user does not have permission.
NotValidException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |