Skip navigation links

waggle.common.modules.chat
Interface XChatModule.Server

All Superinterfaces:

XAPIInterface, XAPIInterface.Server

Enclosing interface:

XChatModule

public static interface XChatModule.Server

extends XAPIInterface.Server

Server interface for the Chat Module API.

Nested Class Summary

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

XAPIInterface.Client, XAPIInterface.Server

Method Summary

XObjectID	createBasicChat(XObjectID conversationID, String chatText) Create a simple Chat.
XObjectID	createChat(XObjectID conversationID, String chatText, XObjectID commentOnChatID, List<XObjectID> referencedObjectIDs) Create a Chat with the most common parameters.
XObjectID	createChatFromInfo(XChatCreateInfo createInfo) Create a Chat with an XChatCreateInfo DTO that includes all possible parameters.
void	editChat(XObjectID chatID, String chatText, List<XObjectID> referenceIDs) Edit the Chat text with optional references.
List<XChatInfo>	getAfterChats(XObjectID conversationID, Date afterDate, int count) Get count top-level Chats after afterDate.
List<XChatInfo>	getAllConferenceChats(XObjectID conversationID) Get all Conference Chats.
List<XChatInfo>	getAroundChats(XObjectID aroundID, int count) Get next and previous count top-level Chats before and after the specified Chat.
List<XChatInfo>	getBeforeChats(XObjectID conversationID, Date beforeDate, int count) Get count top-level Chats before beforeDate.
XChatInfo	getChat(XObjectID chatID) Get specific Chat info.
List<XChatDateInfo>	getChatDates(XObjectID conversationID, Date startDate, Date endDate) Get the set of dates for all top-level Chats.
List<XObjectID>	getChatIDs(XObjectID conversationID) Get all top-level Chat IDs.
List<XObjectID>	getChatIDsPage(XObjectID conversationID, int pageNumber, int pageSize) Get a page of top-level Chat IDs.
List<XChatInfo>	getChatsInRange(XObjectID conversationID, Date startDate, Date endDate) Get all top-level Chats created in the specified date range.
XChatReadInfo	getChatsRead(XObjectID conversationID) Return information about Chats read for the current User.
List<XChatVersionInfo>	getChatVersions(XObjectID chatID) Return an ordered list of a Chat's Versions.
List<XChatInfo>	getFirstChats(XObjectID conversationID, int count) Get first top-level Chats.
List<XChatInfo>	getLastChats(XObjectID conversationID, int count) Get last count top-level Chats.
List<XChatInfo>	getNextChats(XObjectID afterID, int count) Get next count top-level Chats after the specified Chat.
List<XChatInfo>	getPreviousChats(XObjectID beforeID, int count) Get previous count top-level Chats before the specified Chat.
XDTO	getReference(XObjectID referenceID) Get referenced object DTO.
List<XChatInfo>	getSpecifiedChats(XObjectID conversationID, List<XObjectID> chatIDs) Get a specified set of Chats.
XChatSummaryInfo	getSummaryChatIDs(XObjectID conversationID) Returns information about followup and bookmark Chats.
List<XChatInfo>	getUnreadChats(XObjectID conversationID) Return all unread Chats for the current User.
boolean	isRemovableNow(XObjectID chatID) Return true if this chat can be removed now given the current user and object model state.
void	markChatsAllRead(XObjectID conversationID, int ordinal) Mark all existing chats read for the current User.
void	markChatsAllUnread(XObjectID conversationID, int ordinal) Mark all existing chats unread for the current User.
void	markChatsRead(XObjectID conversationID, List<Integer> ordinals) Mark a set of chats read for the current User.
void	markChatsUnread(XObjectID conversationID, List<Integer> ordinals) Mark a set of chats unread for the current User.
void	markUserDigestChatsRead(Date digestStartDate, Date digestEndDate) Mark all the chats included in a user digest as read.
void	removeChat(XObjectID chatID) Marks the Removed flag on the XChatInfo for this chatID.
void	typing(XObjectID conversationID) Sent when a User is typing in a chat window.
void	unremoveChat(XObjectID chatID) Clears the Removed flag on the XChatInfo for this chatID.
void	updateChat(XObjectID chatID, XUpdater updater) Update a Chat.

Method Detail

typing

void typing(XObjectID conversationID)

Sent when a User is typing in a chat window.

Parameters:

conversationID - The Conversation.

createBasicChat

XObjectID createBasicChat(XObjectID conversationID,
                          String chatText)

Create a simple Chat.

Parameters:

conversationID - The Conversation.

chatText - The chat text.

Returns:

The ID of the created Chat.

createChat

XObjectID createChat(XObjectID conversationID,
                     String chatText,
                     XObjectID commentOnChatID,
                     List<XObjectID> referencedObjectIDs)

Create a Chat with the most common parameters. The conversationID parameter may be null only when creating a comment chat whereas the commentOnChatID parameter is not null.

Parameters:

conversationID - The Conversation. May be null if commentOnChatID is provided.

chatText - The Chat text.

commentOnChatID - Chat on which this is a comment. May be null.

referencedObjectIDs - Referenced Object IDs. May be null.

Returns:

The ID of the created Chat.

createChatFromInfo

XObjectID createChatFromInfo(XChatCreateInfo createInfo)

Create a Chat with an XChatCreateInfo DTO that includes all possible parameters.

Parameters:

createInfo - The create info.

Returns:

The ID of the created Chat.

getChat

XChatInfo getChat(XObjectID chatID)

Get specific Chat info.

Parameters:

chatID - The Chat.

Returns:

The Chat Info.

getSpecifiedChats

List<XChatInfo> getSpecifiedChats(XObjectID conversationID,
                                  List<XObjectID> chatIDs)

Get a specified set of Chats.

Parameters:

conversationID - The Conversation.

chatIDs - The Chat IDs in the specified Conversation to return.

Returns:

The Chats.

getChatIDs

List<XObjectID> getChatIDs(XObjectID conversationID)

Get all top-level Chat IDs.

Parameters:

conversationID - The Conversation.

Returns:

The list of top-level Chat IDs in time order.

getChatIDsPage

List<XObjectID> getChatIDsPage(XObjectID conversationID,
                               int pageNumber,
                               int pageSize)

Get a page of top-level Chat IDs.

Parameters:

conversationID - The Conversation.

pageNumber - The page number. Zero (0) based.

pageSize - The page size.

Returns:

The list of top-level Chat IDs in time order.

getSummaryChatIDs

XChatSummaryInfo getSummaryChatIDs(XObjectID conversationID)

Returns information about followup and bookmark Chats.

Parameters:

conversationID - The Conversation.

Returns:

Returns information about followup and bookmark Chats.

getUnreadChats

List<XChatInfo> getUnreadChats(XObjectID conversationID)

Return all unread Chats for the current User.

Parameters:

conversationID - The Conversation.

Returns:

The set of unread Chats.

getChatDates

List<XChatDateInfo> getChatDates(XObjectID conversationID,
                                 Date startDate,
                                 Date endDate)

Get the set of dates for all top-level Chats.

Parameters:

conversationID - The Conversation.

startDate - The start date.

endDate - The end date.

Returns:

The set of all dates in range in which Artifacts were created.

getChatsInRange

List<XChatInfo> getChatsInRange(XObjectID conversationID,
                                Date startDate,
                                Date endDate)

Get all top-level Chats created in the specified date range.

Parameters:

conversationID - The Conversation.

startDate - The start date.

endDate - The end date.

Returns:

The set of children Chats.

getFirstChats

List<XChatInfo> getFirstChats(XObjectID conversationID,
                              int count)

Get first top-level Chats.

Parameters:

conversationID - The Conversation.

count - The maximum number of children to return.

Returns:

The set of children Chats.

getNextChats

List<XChatInfo> getNextChats(XObjectID afterID,
                             int count)

Get next count top-level Chats after the specified Chat.

Parameters:

afterID - Return children after this Chat.

count - The maximum number of children to return.

Returns:

The set of children Chats.

getAroundChats

List<XChatInfo> getAroundChats(XObjectID aroundID,
                               int count)

Get next and previous count top-level Chats before and after the specified Chat.

Parameters:

aroundID - Return children around this Chat.

count - The maximum number of children before and after to return.

Returns:

The set of children Chats.

getPreviousChats

List<XChatInfo> getPreviousChats(XObjectID beforeID,
                                 int count)

Get previous count top-level Chats before the specified Chat.

Parameters:

beforeID - Return children before this Chat.

count - The maximum number of children to return.

Returns:

The set of children Chats.

getLastChats

List<XChatInfo> getLastChats(XObjectID conversationID,
                             int count)

Get last count top-level Chats.

Parameters:

conversationID - The Conversation.

count - The maximum number of children to return.

Returns:

The set of children Chats.

getBeforeChats

List<XChatInfo> getBeforeChats(XObjectID conversationID,
                               Date beforeDate,
                               int count)

Get count top-level Chats before beforeDate.

Parameters:

conversationID - The Conversation.

beforeDate - Get count Chats before this Date.

count - The maximum number of children to return.

Returns:

The set of children Chats.

getAfterChats

List<XChatInfo> getAfterChats(XObjectID conversationID,
                              Date afterDate,
                              int count)

Get count top-level Chats after afterDate.

Parameters:

conversationID - The Conversation.

afterDate - Get count Chats after this Date.

count - The maximum number of children to return.

Returns:

The set of children Chats.

getAllConferenceChats

List<XChatInfo> getAllConferenceChats(XObjectID conversationID)

Get all Conference Chats.

Parameters:

conversationID - The Conversation.

Returns:

A list of all Conference Chats.

getChatsRead

XChatReadInfo getChatsRead(XObjectID conversationID)

Return information about Chats read for the current User.

Parameters:

conversationID - The Conversation.

Returns:

The Chats read info DTO.

markChatsRead

void markChatsRead(XObjectID conversationID,
                   List<Integer> ordinals)

Mark a set of chats read for the current User.

Parameters:

conversationID - The Conversation in which to mark the chats read

ordinals - The Chats (by ordinal) to mark read.

markChatsUnread

void markChatsUnread(XObjectID conversationID,
                     List<Integer> ordinals)

Mark a set of chats unread for the current User.

Parameters:

conversationID - The Conversation in which to mark the chats unread.

ordinals - The Chats (by ordinal) to mark unread.

markChatsAllRead

void markChatsAllRead(XObjectID conversationID,
                      int ordinal)

Mark all existing chats read for the current User.

Parameters:

conversationID - The Conversation in which to mark the chats read.

ordinal - The maximum ordinal read.

markChatsAllUnread

void markChatsAllUnread(XObjectID conversationID,
                        int ordinal)

Mark all existing chats unread for the current User.

Parameters:

conversationID - The Conversation in which to mark the chats read.

ordinal - The maximum ordinal unread.

markUserDigestChatsRead

void markUserDigestChatsRead(Date digestStartDate,
                             Date digestEndDate)

Mark all the chats included in a user digest as read.

Parameters:

digestStartDate - the start date of the digest

digestEndDate - the end date of the digest

getReference

XDTO getReference(XObjectID referenceID)

Get referenced object DTO.

Parameters:

referenceID - The Reference.

Returns:

The Reference DTO. Returns null if reference is not accessible.

updateChat

void updateChat(XObjectID chatID,
                XUpdater updater)

Update a Chat.

Parameters:

chatID - The Chat.

updater - The updater.

editChat

void editChat(XObjectID chatID,
              String chatText,
              List<XObjectID> referenceIDs)

Edit the Chat text with optional references. Any existing references will be removed. A new Version is added.

Parameters:

chatID - The Chat.

chatText - The new Chat text.

referenceIDs - Referenced IDs. May be null.

getChatVersions

List<XChatVersionInfo> getChatVersions(XObjectID chatID)

Return an ordered list of a Chat's Versions.

Parameters:

chatID - The Chat.

Returns:

The Chat Version infos.

isRemovableNow

boolean isRemovableNow(XObjectID chatID)

Return true if this chat can be removed now given the current user and object model state.

Parameters:

chatID - The Chat to check

Returns:

true if this chat can be removed now given the current user and object model state; false otherwise

removeChat

void removeChat(XObjectID chatID)

Marks the Removed flag on the XChatInfo for this chatID.

1 - if the conversation is closed, no chats in the conversation can be removed. 2 - if the chat XChatInfo.RemovableType flag is false, the chat can never be removed. 3 - if the chat belongs to a conference, then check if the conference is open or closed. The chat cannot be removed while the conference is open. 4 - if the chat XChatInfo.Removed (inherited from XObjectInfo.Removed) flag is true, the chat cannot be removed.

Parameters:

chatID - The Chat to mark removed.

See Also:

XObjectInfo.Removed

unremoveChat

void unremoveChat(XObjectID chatID)

Clears the Removed flag on the XChatInfo for this chatID.

Parameters:

chatID - The Chat to mark unremoved.

See Also:

XObjectInfo.Removed

Skip navigation links