com.comapi.chat.model

Class ChatStore

java.lang.Object

com.comapi.chat.model.ChatStore

public abstract class ChatStore
extends java.lang.Object

Top level interface for db storage.

Since:

1.0.0

Constructor Summary

Constructors

Constructor and Description
ChatStore()

Method Summary

Modifier and Type	Method and Description
abstract void	beginTransaction() Begin transaction.
abstract boolean	clearDatabase() Delete all content of persistence store that is related to current user.
abstract void	close() Close database.
abstract boolean	deleteAllMessages(java.lang.String conversationId) Delete all messages from persistence store that are related to given conversation.
abstract boolean	deleteConversation(java.lang.String conversationId) Delete conversation from persistence store.
abstract boolean	deleteMessage(java.lang.String conversationId, java.lang.String messageId) Delete message from persistence store.
abstract void	endTransaction() End transaction.
abstract java.util.List<ChatConversationBase>	getAllConversations() Get all conversations from persistence store.
abstract ChatConversationBase	getConversation(java.lang.String conversationId) Get conversation from persistence store.
abstract void	open() Open/prepare database.
abstract boolean	update(ChatConversationBase conversation) Update conversation in persistence store.
abstract boolean	update(ChatMessageStatus status) Update stored ChatMessage with a new ChatMessageStatus.
abstract boolean	upsert(ChatConversation conversation) Insert or update conversation in persistence store.
abstract boolean	upsert(ChatMessage message) Insert or update message in persistence store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChatStore

public ChatStore()

Method Detail

getConversation

public abstract ChatConversationBase getConversation(java.lang.String conversationId)

Get conversation from persistence store.

Parameters:

conversationId - Unique global conversation identifier.

Returns:

Conversation from persistence store.

getAllConversations

public abstract java.util.List<ChatConversationBase> getAllConversations()

Get all conversations from persistence store.

Returns:

All conversations from persistence store.

upsert

public abstract boolean upsert(ChatConversation conversation)

Insert or update conversation in persistence store.

Parameters:

conversation - Conversation to insert or update.

Returns:

True if operation was successful.

update

public abstract boolean update(ChatConversationBase conversation)

Update conversation in persistence store.

Parameters:

conversation - Conversation to update.

Returns:

True if operation was successful.

deleteConversation

public abstract boolean deleteConversation(java.lang.String conversationId)

Delete conversation from persistence store.

Parameters:

conversationId - Unique global conversation identifier of an conversation to delete.

Returns:

True if operation was successful.

upsert

public abstract boolean upsert(ChatMessage message)

Insert or update message in persistence store.

Parameters:

message - Message to insert or update.

Returns:

True if operation was successful.

update

public abstract boolean update(ChatMessageStatus status)

Update stored ChatMessage with a new ChatMessageStatus. The chat message is unique for a combination of messageId, profileId and LocalMessageStatus value.

Parameters:

status - Chat message status for the ChatMessage with id ChatMessageStatus.getMessageId()

Returns:

True if operation was successful.

deleteAllMessages

public abstract boolean deleteAllMessages(java.lang.String conversationId)

Delete all messages from persistence store that are related to given conversation.

Parameters:

conversationId - Unique global conversation identifier.

Returns:

True if operation was successful.

deleteMessage

public abstract boolean deleteMessage(java.lang.String conversationId,
                                      java.lang.String messageId)

Delete message from persistence store.

Parameters:

conversationId - Unique global conversation identifier.

messageId - Unique global message identifier.

Returns:

True if operation was successful.

clearDatabase

public abstract boolean clearDatabase()

Delete all content of persistence store that is related to current user.

Returns:

True if operation was successful.

beginTransaction

public abstract void beginTransaction()

Begin transaction. From this point calling other methods of this class will queue store updates and inserts to be executed when endTransaction() on same instance is called.

endTransaction

public abstract void endTransaction()

End transaction. Execute queued store updates and inserts.

open

public abstract void open()

Open/prepare database.

close

public abstract void close()

Close database.