Package com.xpn.xwiki.store

Interface XWikiAttachmentStoreInterface

All Known Implementing Classes:

XWikiHibernateAttachmentStore

@Role
public interface XWikiAttachmentStoreInterface

Interface for Attachment store system.

Version:

$Id: 08275a0baa29a89ed7afc31c590af3c84004fafb $

Method Summary

Modifier and Type	Method	Description
default boolean	attachmentContentExists(XWikiAttachment attachment, XWikiContext context, boolean bTransaction)
void	cleanUp(XWikiContext context)
void	deleteXWikiAttachment(XWikiAttachment attachment, boolean parentUpdate, XWikiContext context, boolean bTransaction)
void	deleteXWikiAttachment(XWikiAttachment attachment, XWikiContext context, boolean bTransaction)
String	getHint()
void	loadAttachmentContent(XWikiAttachment attachment, XWikiContext context, boolean bTransaction)
void	saveAttachmentContent(XWikiAttachment attachment, boolean bParentUpdate, XWikiContext context, boolean bTransaction)
void	saveAttachmentContent(XWikiAttachment attachment, XWikiContext context, boolean bTransaction)
void	saveAttachmentsContent(List<XWikiAttachment> attachments, XWikiDocument doc, boolean bParentUpdate, XWikiContext context, boolean bTransaction)

Method Detail

getHint

String getHint()

Returns:

the role hint of the component

Since:

9.10RC1

saveAttachmentContent

void saveAttachmentContent(XWikiAttachment attachment,
                           XWikiContext context,
                           boolean bTransaction)
                    throws XWikiException

Throws:

XWikiException

saveAttachmentContent

void saveAttachmentContent(XWikiAttachment attachment,
                           boolean bParentUpdate,
                           XWikiContext context,
                           boolean bTransaction)
                    throws XWikiException

Throws:

XWikiException

saveAttachmentsContent

void saveAttachmentsContent(List<XWikiAttachment> attachments,
                            XWikiDocument doc,
                            boolean bParentUpdate,
                            XWikiContext context,
                            boolean bTransaction)
                     throws XWikiException

Throws:

XWikiException

loadAttachmentContent

void loadAttachmentContent(XWikiAttachment attachment,
                           XWikiContext context,
                           boolean bTransaction)
                    throws XWikiException

Throws:

XWikiException

attachmentContentExists

default boolean attachmentContentExists(XWikiAttachment attachment,
                                        XWikiContext context,
                                        boolean bTransaction)
                                 throws XWikiException

Parameters:

attachment -

context - the XWiki context

bTransaction -

Returns:

true of the content of this attachment still exist in the store

Throws:

XWikiException - when it's not possible to check of the content exist

Since:

13.8RC1, 13.4.4, 12.10.10

deleteXWikiAttachment

void deleteXWikiAttachment(XWikiAttachment attachment,
                           XWikiContext context,
                           boolean bTransaction)
                    throws XWikiException

Throws:

XWikiException

deleteXWikiAttachment

void deleteXWikiAttachment(XWikiAttachment attachment,
                           boolean parentUpdate,
                           XWikiContext context,
                           boolean bTransaction)
                    throws XWikiException

Throws:

XWikiException

cleanUp

void cleanUp(XWikiContext context)