Package com.xpn.xwiki.store

Interface AttachmentVersioningStore

All Known Implementing Classes:

HibernateAttachmentVersioningStore, VoidAttachmentVersioningStore

@Role
public interface AttachmentVersioningStore

Interface for storing attachment versions.

Since:

1.4M2

Version:

$Id: 05f3a2fee818bcd8f1dc329b29fb9704857c0162 $

Method Summary

Modifier and Type	Method	Description
void	deleteArchive(XWikiAttachment attachment, XWikiContext context, boolean bTransaction)	Permanently delete attachment archive.
String	getHint()
XWikiAttachmentArchive	loadArchive(XWikiAttachment attachment, XWikiContext context, boolean bTransaction)	Load attachment archive from store.
void	saveArchive(XWikiAttachmentArchive archive, XWikiContext context, boolean bTransaction)	Save or update attachment archive.

Method Detail

getHint

String getHint()

Returns:

the role hint of the component

Since:

9.10RC1

loadArchive

XWikiAttachmentArchive loadArchive(XWikiAttachment attachment,
                                   XWikiContext context,
                                   boolean bTransaction)
                            throws XWikiException

Load attachment archive from store.

Parameters:

attachment - The attachment of archive.

context - The current context.

bTransaction - Should use old transaction (false) or create new (true).

Returns:

attachment archive. not null. return empty archive if it is not exist in store.

Throws:

XWikiException - If an error occurs.

saveArchive

void saveArchive(XWikiAttachmentArchive archive,
                 XWikiContext context,
                 boolean bTransaction)
          throws XWikiException

Save or update attachment archive.

Parameters:

archive - The attachment archive to save.

context - The current context.

bTransaction - Should use old transaction (false) or create new (true).

Throws:

XWikiException - If an error occurs.

deleteArchive

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

Permanently delete attachment archive.

Parameters:

attachment - The attachment to delete.

context - The current context.

bTransaction - Should use old transaction (false) or create new (true).

Throws:

XWikiException - If an error occurs.