Skip navigation links

waggle.common.modules.annotation
Interface XAnnotationModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XAnnotationModule

public static interface XAnnotationModule.Server

extends XAPIInterface.Server

Server interface for the Annotation Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

void	commitAnnotationDraft(XObjectID versionID) Commit and delete a Version draft.
void	deleteAnnotationDraft(XObjectID versionID) Delete an annotation draft.
List<XChatInfo>	getAnnotationChats(XObjectID versionID) Return all system generated Annotation Chats on a Version sorted by position.
List<XAnnotationMarkupInfo>	getAnnotationDraft(XObjectID versionID) Get any draft markups.
List<XAnnotationDraftInfo>	getAnnotationDrafts(XObjectID conversationID) Get any draft markups for the specified Conversation.
void	saveAnnotationDraft(XObjectID versionID, List<XAnnotationMarkupInfo> infos) Save an annotation draft.

Method Detail

saveAnnotationDraft

void saveAnnotationDraft(XObjectID versionID,
                         List<XAnnotationMarkupInfo> infos)

Save an annotation draft.

Parameters:

versionID - The Version.

infos - The markup.

getAnnotationDraft

List<XAnnotationMarkupInfo> getAnnotationDraft(XObjectID versionID)

Get any draft markups.

Parameters:

versionID - The Version.

Returns:

The Markups.

commitAnnotationDraft

void commitAnnotationDraft(XObjectID versionID)

Commit and delete a Version draft.

Parameters:

versionID - The Version.

deleteAnnotationDraft

void deleteAnnotationDraft(XObjectID versionID)

Delete an annotation draft.

Parameters:

versionID - The Version.

getAnnotationDrafts

List<XAnnotationDraftInfo> getAnnotationDrafts(XObjectID conversationID)

Get any draft markups for the specified Conversation.

Parameters:

conversationID - The Conversation.

Returns:

The Document/Versions that have outstanding drafts in this Conversation.

getAnnotationChats

List<XChatInfo> getAnnotationChats(XObjectID versionID)

Return all system generated Annotation Chats on a Version sorted by position.

Parameters:

versionID - The Version.

Returns:

The system generated Annotation Chats.

Skip navigation links