Package com.atlassian.confluence.api.service.content

Interface ContentTrashService

All Known Implementing Classes:

ContentTrashServiceImpl

public interface ContentTrashService

Controls trashing, restoring and purging Content from the instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ContentTrashService.Validator	Provides methods for validating the trash, restore and purge methods.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TRASH_DATE_METADATA_KEY	Trash date is stored in the Content metadata as the "trashdate" entry.

Method Summary

Modifier and Type	Method	Description
void	purge(Content content)	Permanently delete a piece of content.
Content	restore(Content content)	Restore a trashed piece of content.
void	trash(Content content)	Trash a piece of content.
ContentTrashService.Validator	validator()	Get the validator view of this service.

Field Detail

TRASH_DATE_METADATA_KEY

static final String TRASH_DATE_METADATA_KEY

Trash date is stored in the Content metadata as the "trashdate" entry.

See Also:

Constant Field Values

Method Detail

trash

void trash(Content content)

Trash a piece of content.

The purge(Content) method can be used for content that doesn't support trashing. Currently, only content with types ContentType.PAGE, ContentType.BLOG_POST and ContentType.ATTACHMENT (as of Confluence 5.8) support trashing.

Parameters:

content - the content to be trashed

Throws:

NotFoundException - if no current content matches the supplied content. If the supplied content is already trashed, the purge(Content) should be used instead.

BadRequestException - if the supplied content is invalid

PermissionException - if the current user is not permitted to trash the content

restore

Content restore(Content content)

Restore a trashed piece of content.

Parameters:

content - the content to be restored

Returns:

the content after being restored

Throws:

NotFoundException - if no stored content matches the supplied content

BadRequestException - if the supplied content is invalid

PermissionException - if the current user is not permitted to restore the content

purge

void purge(Content content)

Permanently delete a piece of content.

There are two main cases:

• Trashable content (e.g. Pages, BlogPosts) must have status "trashed" to be purged.
• Non-trashable content (e.g. Comments, Attachment) can be purged with status "current".

Parameters:

content - the content to be purged

Throws:

NotFoundException - if no purgable content matches the supplied content. This can happen if no content matches the id, or if the content found is trashable but not trashed.

BadRequestException - if the supplied content is invalid

PermissionException - if the current user is not permitted to purge the content

validator

ContentTrashService.Validator validator()

Get the validator view of this service.

Returns:

a Validator that can be used to validate service requests.