WCConversation.h

/* $Id: WCMessage.h 6709 2009-01-22 16:08:51Z morris $ */

/*
 *  Copyright (c) 2003-2009 Axel Andersson
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#import "WCServerConnectionObject.h"
#import "WCWebDataSource.h"

@class WCMessage, WCUser;

@interface WCConversation : WCServerConnectionObject {
	NSString					*_name;
	NSMutableArray				*_conversations;
	NSMutableArray				*_messages;
	NSString					*_nick;
	BOOL						_expandable;
	BOOL						_unread;
	
	WCUser						*_user;
}

+ (id)rootConversation;
+ (id)conversationWithUser:(WCUser *)user connection:(WCServerConnection *)connection;

- (NSString *)name;
- (BOOL)isExpandable;
- (void)setUnread:(BOOL)unread;
- (BOOL)isUnread;
- (void)setUser:(WCUser *)user;
- (WCUser *)user;
- (NSString *)nick;

- (NSUInteger)numberOfConversations;
- (NSArray *)conversations;
- (WCConversation *)conversationAtIndex:(NSUInteger)index;
- (WCConversation *)conversationForUser:(WCUser *)user connection:(WCServerConnection *)connection;
- (WCConversation *)previousUnreadConversationStartingAtConversation:(WCConversation *)conversation;
- (WCConversation *)nextUnreadConversationStartingAtConversation:(WCConversation *)conversation;
- (void)addConversations:(NSArray *)conversations;
- (void)addConversation:(WCConversation *)conversation;
- (void)removeConversation:(WCConversation *)conversation;
- (void)removeAllConversations;

- (NSUInteger)numberOfMessages;
- (NSUInteger)numberOfUnreadMessagesForConnection:(WCServerConnection *)connection includeChildConversations:(BOOL)includeChildConversations;
- (NSArray *)messages;
- (NSArray *)unreadMessages;
- (WCMessage *)messageAtIndex:(NSUInteger)index;
- (void)addMessage:(WCMessage *)message;
- (void)removeMessage:(WCMessage *)message;
- (void)removeAllMessages;

- (void)invalidateForConnection:(WCServerConnection *)connection;
- (void)revalidateForConnection:(WCServerConnection *)connection;
- (void)invalidateForUser:(WCUser *)user;
- (void)revalidateForUser:(WCUser *)user;

//+ (BOOL)isSelectorExcludedFromWebScript:(SEL)aSelector;
//+ (BOOL)isKeyExcludedFromWebScript:(const char *)name;

@end


@interface WCMessageConversation : WCConversation

@end


@interface WCBroadcastConversation : WCConversation

@end