Skip navigation links

waggle.common.modules.document
Interface XDocumentModule.Client

All Superinterfaces:

XAPIInterface, XAPIInterface.Client

Enclosing interface:

XDocumentModule

public static interface XDocumentModule.Client

extends XAPIInterface.Client

Client interface for the Documents Module API.

Nested Class Summary

Nested classes/interfaces inherited from interface waggle.core.api.XAPIInterface

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	documentDeleted(XDocumentInfo documentInfo) Notification that a Document has been deleted.
void	documentLocked(XDocumentInfo documentInfo) Notification that an Document has been locked.
void	documentRemoved(XDocumentInfo documentInfo) Notification that a Document has been removed.
void	documentUnlocked(XDocumentInfo documentInfo) Notification that an Document has been unlocked.
void	documentUnremoved(XDocumentInfo documentInfo) Notification that a Document has been un-removed.
void	versionAdded(XDocumentInfo documentInfo, XVersionInfo versionInfo) Notification that an Document Version has been added.
void	versionDeleted(XDocumentInfo documentInfo, XVersionInfo versionInfo) Notification that a Document Version has been deleted.
void	versionRemoved(XDocumentInfo documentInfo, XVersionInfo versionInfo) Notification that a Document Version has been removed.
void	versionRenditionsReady(XDocumentInfo documentInfo, XVersionInfo versionInfo) Notification that a Document Version's renditions are ready.
void	versionUnremoved(XDocumentInfo documentInfo, XVersionInfo versionInfo) Notification that a Document Version has been un-removed.
void	versionUpdated(XDocumentInfo documentInfo, XVersionInfo versionInfo) Notification that an Document Version has been updated.

Method Detail

documentLocked

void documentLocked(XDocumentInfo documentInfo)

Notification that an Document has been locked.

Parameters:

documentInfo - The DocumentInfo.

documentUnlocked

void documentUnlocked(XDocumentInfo documentInfo)

Notification that an Document has been unlocked.

Parameters:

documentInfo - The DocumentInfo.

documentRemoved

void documentRemoved(XDocumentInfo documentInfo)

Notification that a Document has been removed.

Parameters:

documentInfo - The DocumentInfo.

documentUnremoved

void documentUnremoved(XDocumentInfo documentInfo)

Notification that a Document has been un-removed.

Parameters:

documentInfo - The DocumentInfo.

documentDeleted

void documentDeleted(XDocumentInfo documentInfo)

Notification that a Document has been deleted.

Parameters:

documentInfo - The DocumentInfo.

versionAdded

void versionAdded(XDocumentInfo documentInfo,
                  XVersionInfo versionInfo)

Notification that an Document Version has been added.

Parameters:

documentInfo - The DocumentInfo.

versionInfo - The VersionInfo.

versionUpdated

void versionUpdated(XDocumentInfo documentInfo,
                    XVersionInfo versionInfo)

Notification that an Document Version has been updated.

Parameters:

documentInfo - The DocumentInfo.

versionInfo - The VersionInfo.

versionRenditionsReady

void versionRenditionsReady(XDocumentInfo documentInfo,
                            XVersionInfo versionInfo)

Notification that a Document Version's renditions are ready.

Parameters:

documentInfo - The DocumentInfo.

versionInfo - The VersionInfo.

versionRemoved

void versionRemoved(XDocumentInfo documentInfo,
                    XVersionInfo versionInfo)

Notification that a Document Version has been removed.

Parameters:

documentInfo - The DocumentInfo.

versionInfo - The VersionInfo.

versionUnremoved

void versionUnremoved(XDocumentInfo documentInfo,
                      XVersionInfo versionInfo)

Notification that a Document Version has been un-removed.

Parameters:

documentInfo - The DocumentInfo.

versionInfo - The VersionInfo.

versionDeleted

void versionDeleted(XDocumentInfo documentInfo,
                    XVersionInfo versionInfo)

Notification that a Document Version has been deleted.

Parameters:

documentInfo - The DocumentInfo.

versionInfo - The VersionInfo.

Skip navigation links