sogo/SoObjects/SOGo/SOGoGCSFolder.h

144 lines
4.2 KiB
Objective-C

/*
Copyright (C) 2004-2005 SKYRIX Software AG
Copyright (C) 2006-2015 Inverse inc.
This file is part of SOGo.
SOGo is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.
SOGo is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with OGo; see the file COPYING. If not, write to the
Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
*/
#ifndef __SOGo_SOGoGCSFolder_H__
#define __SOGo_SOGoGCSFolder_H__
#import "SOGoFolder.h"
@class NSArray;
@class NSDictionary;
@class NSMutableDictionary;
@class NSString;
@class GCSFolder;
@class WOContext;
@class WOResponse;
@class SOGoUser;
@protocol DOMElement;
/*
SOGoGCSFolder
A common superclass for folders stored in GCS. Already deals with all GCS
folder specific things.
Important: folders should NOT retain the context! Otherwise you might get
cyclic references.
*/
@interface SOGoGCSFolder : SOGoFolder
{
NSString *ocsPath;
GCSFolder *ocsFolder;
NSMutableDictionary *childRecords;
BOOL userCanAccessAllObjects; /* i.e. user obtains 'Access Object' on
subobjects */
}
+ (id) folderWithSubscriptionReference: (NSString *) reference
inContainer: (id) aContainer;
/* accessors */
- (void) setOCSPath: (NSString *)_Path;
- (NSString *) ocsPath;
- (GCSFolder *) ocsFolderForPath: (NSString *)_path;
- (GCSFolder *) ocsFolder;
- (NSString *) folderReference;
- (NSArray *) pathArrayToFolder;
- (void) setFolderPropertyValue: (id) theValue
inCategory: (NSString *) theKey;
- (id) folderPropertyValueInCategory: (NSString *) theKey;
- (id) folderPropertyValueInCategory: (NSString *) theKey
forUser: (SOGoUser *) theUser;
- (BOOL) synchronize;
- (void) setSynchronize: (BOOL) new;
/* lower level fetches */
- (void) deleteEntriesWithIds: (NSArray *) ids;
- (Class) objectClassForComponentName: (NSString *) componentName;
- (Class) objectClassForContent: (NSString *) content;
- (void) removeChildRecordWithName: (NSString *) childName;
- (id) createChildComponentWithRecord: (NSDictionary *) record;
- (id) createChildComponentWithName: (NSString *) newName
andContent: (NSString *) newContent;
/* folder type */
- (BOOL) folderIsMandatory;
- (BOOL) create;
- (NSException *) delete;
- (void) renameTo: (NSString *) newName;
- (void) removeFolderSettings: (NSMutableDictionary *) moduleSettings
withReference: (NSString *) reference;
- (BOOL) subscribeUserOrGroup: (NSString *) theIdentifier
reallyDo: (BOOL) reallyDo
response: (WOResponse *) theResponse;
- (BOOL) userIsSubscriber: (NSString *) subscribingUser;
- (void) initializeQuickTablesAclsInContext: (WOContext *) localContext;
/* acls as a container */
- (NSArray *) aclUsersForObjectAtPath: (NSArray *) objectPathArray;
- (NSArray *) aclsForUser: (NSString *) uid
forObjectAtPath: (NSArray *) objectPathArray;
- (void) setRoles: (NSArray *) roles
forUser: (NSString *) uid
forObjectAtPath: (NSArray *) objectPathArray;
- (void) removeAclsForUsers: (NSArray *) users
forObjectAtPath: (NSArray *) objectPathArray;
/* DAV */
- (NSURL *) publicDavURL;
- (NSURL *) realDavURL;
- (NSDictionary *) davSQLFieldsTable;
- (NSDictionary *) parseDAVRequestedProperties: (id <DOMElement>) propElement;
- (NSString *) davCollectionTag;
- (NSArray *) syncTokenFieldsWithProperties: (NSDictionary *) properties
matchingSyncToken: (NSString *) syncToken
fromDate: (NSCalendarDate *) theStartDate
initialLoad: (BOOL) initialLoadInProgress;
/* multiget helper */
- (WOResponse *) performMultigetInContext: (WOContext *) queryContext
inNamespace: (NSString *) namespace;
@end
#endif /* __SOGo_SOGoGCSFolder_H__ */