/Source/externals/GData/Source/Clients/Calendar/GDataEntryCalendar.h

  1/* Copyright (c) 2007 Google Inc.
  2 *
  3 * Licensed under the Apache License, Version 2.0 (the "License");
  4 * you may not use this file except in compliance with the License.
  5 * You may obtain a copy of the License at
  6 *
  7 *     http://www.apache.org/licenses/LICENSE-2.0
  8 *
  9 * Unless required by applicable law or agreed to in writing, software
 10 * distributed under the License is distributed on an "AS IS" BASIS,
 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 12 * See the License for the specific language governing permissions and
 13 * limitations under the License.
 14 */
 15
 16//
 17//  GDataEntryCalendar.h
 18//
 19
 20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_CALENDAR_SERVICE
 21
 22#import "GDataEntryBase.h"
 23#import "GDataLink.h"
 24#import "GDataValueConstruct.h"
 25
 26#undef _EXTERN
 27#undef _INITIALIZE_AS
 28#ifdef GDATAENTRYCALENDAR_DEFINE_GLOBALS
 29#define _EXTERN 
 30#define _INITIALIZE_AS(x) =x
 31#else
 32#define _EXTERN GDATA_EXTERN
 33#define _INITIALIZE_AS(x)
 34#endif
 35
 36_EXTERN NSString* const kGDataCalendarDefaultServiceVersion _INITIALIZE_AS(@"2.1");
 37
 38_EXTERN NSString* const kGDataExtendedPropertyRealmCalendar _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#calendar");
 39
 40
 41// http://code.google.com/apis/calendar/reference.html#Elements  Says:
 42// "accessLevel must be one of the following:"
 43_EXTERN NSString* const kGDataCalendarAccessNone        _INITIALIZE_AS(@"none");
 44_EXTERN NSString* const kGDataCalendarAccessRead        _INITIALIZE_AS(@"read");
 45_EXTERN NSString* const kGDataCalendarAccessFreeBusy    _INITIALIZE_AS(@"freebusy");
 46_EXTERN NSString* const kGDataCalendarAccessRespond     _INITIALIZE_AS(@"respond");
 47_EXTERN NSString* const kGDataCalendarAccessOverride    _INITIALIZE_AS(@"override");
 48_EXTERN NSString* const kGDataCalendarAccessEditor      _INITIALIZE_AS(@"editor");
 49_EXTERN NSString* const kGDataCalendarAccessOwner       _INITIALIZE_AS(@"owner");
 50_EXTERN NSString* const kGDataCalendarAccessRoot        _INITIALIZE_AS(@"root");
 51
 52// GDataACLRole values
 53_EXTERN NSString* const kGDataRoleCalendarNone        _INITIALIZE_AS(@"none"); // no prefix
 54_EXTERN NSString* const kGDataRoleCalendarRead        _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#read");
 55_EXTERN NSString* const kGDataRoleCalendarFreeBusy    _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#freebusy");
 56_EXTERN NSString* const kGDataRoleCalendarRespond     _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#respond");
 57_EXTERN NSString* const kGDataRoleCalendarOverride    _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#override");
 58_EXTERN NSString* const kGDataRoleCalendarContributor _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#contributor");
 59_EXTERN NSString* const kGDataRoleCalendarEditor      _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#editor");
 60_EXTERN NSString* const kGDataRoleCalendarOwner       _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#owner");
 61_EXTERN NSString* const kGDataRoleCalendarRoot        _INITIALIZE_AS(@"http://schemas.google.com/gCal/2005#root");
 62
 63@class GDataWhen;
 64@class GDataWhere;
 65
 66// CalendarEntry extensions
 67@interface GDataHiddenProperty : GDataBoolValueConstruct <GDataExtension>
 68+ (NSString *)extensionElementURI;
 69+ (NSString *)extensionElementPrefix;
 70+ (NSString *)extensionElementLocalName;
 71@end
 72
 73@interface GDataSelectedProperty : GDataBoolValueConstruct <GDataExtension>
 74+ (NSString *)extensionElementURI;
 75+ (NSString *)extensionElementPrefix;
 76+ (NSString *)extensionElementLocalName;
 77@end
 78
 79@interface GDataTimesCleanedProperty : GDataValueConstruct <GDataExtension>
 80+ (NSString *)extensionElementURI;
 81+ (NSString *)extensionElementPrefix;
 82+ (NSString *)extensionElementLocalName;
 83@end
 84
 85@interface GDataTimeZoneProperty : GDataValueConstruct <GDataExtension>
 86+ (NSString *)extensionElementURI;
 87+ (NSString *)extensionElementPrefix;
 88+ (NSString *)extensionElementLocalName;
 89@end
 90
 91@interface GDataOverrideNameProperty : GDataValueConstruct <GDataExtension>
 92+ (NSString *)extensionElementURI;
 93+ (NSString *)extensionElementPrefix;
 94+ (NSString *)extensionElementLocalName;
 95@end
 96
 97@interface GDataAccessLevelProperty : GDataValueConstruct <GDataExtension>
 98+ (NSString *)extensionElementURI;
 99+ (NSString *)extensionElementPrefix;
100+ (NSString *)extensionElementLocalName;
101@end
102
103@interface GDataColorProperty : GDataValueConstruct <GDataExtension>
104+ (NSString *)extensionElementURI;
105+ (NSString *)extensionElementPrefix;
106+ (NSString *)extensionElementLocalName;
107@end
108
109@interface GDataEntryCalendar : GDataEntryBase {
110}
111
112+ (NSDictionary *)calendarNamespaces;
113
114+ (GDataEntryCalendar *)calendarEntry;
115
116- (GDataColorProperty *)color;
117- (void)setColor:(GDataColorProperty *)val;
118
119- (BOOL)isHidden;
120- (void)setIsHidden:(BOOL)flag;
121
122- (BOOL)isSelected;
123- (void)setIsSelected:(BOOL)flag;
124
125- (GDataTimeZoneProperty *)timeZoneName;
126- (void)setTimeZoneName:(GDataTimeZoneProperty *)theString;
127
128- (NSNumber *)timesCleaned; // int
129- (void)setTimesCleaned:(NSNumber *)num;
130
131- (GDataOverrideNameProperty *)overrideName;
132- (void)setOverrideName:(GDataOverrideNameProperty *)theString;
133
134- (GDataAccessLevelProperty *)accessLevel;
135- (void)setAccessLevel:(GDataAccessLevelProperty *)accessLevel;
136
137- (NSArray *)whens;
138- (void)setWhens:(NSArray *)array;
139- (void)addWhen:(GDataWhen *)obj;
140
141- (NSArray *)locations; // GDWhere objects
142- (void)setLocations:(NSArray *)array;
143- (void)addLocation:(GDataWhere *)obj;
144@end
145
146#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_CALENDAR_SERVICE