/core/externals/update-engine/externals/gdata-objectivec-client/Source/Clients/Calendar/GDataEntryEvent.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//  GDataEntryEvent.h
 18//
 19
 20#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_CALENDAR_SERVICE
 21
 22#import "GDataEntryBase.h"
 23#import "GDataLink.h"
 24
 25#undef _EXTERN
 26#undef _INITIALIZE_AS
 27#ifdef GDATAENTRYEVENT_DEFINE_GLOBALS
 28#define _EXTERN 
 29#define _INITIALIZE_AS(x) =x
 30#else
 31#define _EXTERN GDATA_EXTERN
 32#define _INITIALIZE_AS(x)
 33#endif
 34
 35_EXTERN NSString* const kGDataCategoryEvent _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event");
 36
 37_EXTERN NSString* const kGDataEventStatusConfirmed _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.confirmed");
 38_EXTERN NSString* const kGDataEventStatusTentative _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.tentative");
 39_EXTERN NSString* const kGDataEventStatusCanceled _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.canceled");
 40
 41_EXTERN NSString* const kGDataEventTransparencyTransparent _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.transparent");
 42_EXTERN NSString* const kGDataEventTransparencyOpaque _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.opaque");
 43
 44_EXTERN NSString* const kGDataEventVisibilityDefault _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.default");
 45_EXTERN NSString* const kGDataEventVisibilityPublic _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.public");
 46_EXTERN NSString* const kGDataEventVisibilityPrivate _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.private");
 47_EXTERN NSString* const kGDataEventVisibilityConfidential _INITIALIZE_AS(@"http://schemas.google.com/g/2005#event.confidental");
 48
 49
 50#import "GDataValueConstruct.h"
 51#import "GDataWhen.h"
 52
 53#import "GDataReminder.h"
 54#import "GDataRecurrence.h"
 55#import "GDataRecurrenceException.h"
 56#import "GDataOriginalEvent.h"
 57#import "GDataComment.h"
 58#import "GDataWhere.h"
 59#import "GDataWho.h"
 60
 61// EventEntry extensions
 62
 63// These extensions are just subclasses of GDataValueConstruct.
 64// We're creating them as unique subclasses so they can exist
 65// separately in the extensions list, which stores found extensions
 66// by class.
 67
 68@interface GDataEventStatus : GDataValueConstruct <GDataExtension>
 69+ (NSString *)extensionElementURI;
 70+ (NSString *)extensionElementPrefix;
 71+ (NSString *)extensionElementLocalName;
 72@end
 73
 74@interface GDataVisibility : GDataValueConstruct <GDataExtension>
 75+ (NSString *)extensionElementURI;
 76+ (NSString *)extensionElementPrefix;
 77+ (NSString *)extensionElementLocalName;
 78@end
 79
 80@interface GDataTransparency : GDataValueConstruct <GDataExtension>
 81+ (NSString *)extensionElementURI;
 82+ (NSString *)extensionElementPrefix;
 83+ (NSString *)extensionElementLocalName;
 84@end
 85
 86// EventEntry categories for extensions
 87
 88// We're defining Reminders as extensions to When elements.
 89// This category on When elements will simpify access to those
 90// reminders that are found inside When elements.
 91
 92@interface GDataWhen (GDataCalendarEntryEventExtensions)
 93- (NSArray *)reminders;
 94- (void)setReminders:(NSArray *)arr;
 95- (void)addReminder:(GDataReminder *)obj;
 96@end
 97
 98@interface GDataEntryEvent : GDataEntryBase {
 99}
100
101// a side-effect of calling setRecurrence is to switch reminder elements
102// between recurrence (in the event) and non-recurrence (in the first 
103// event time)
104- (GDataRecurrence *)recurrence;
105- (void)setRecurrence:(GDataRecurrence *)obj;
106
107- (NSArray *)recurrenceExceptions;
108- (void)setRecurrenceExceptions:(NSArray *)arr;
109- (void)addRecurrenceException:(GDataRecurrenceException *)obj;
110
111- (GDataOriginalEvent *)originalEvent;
112- (void)setOriginalEvent:(GDataOriginalEvent *)event;
113
114- (GDataComment *)comment;
115- (void)setComment:(GDataComment *)event;
116
117// these reminder methods will call the recurrence or non-recurrence
118// methods depending on the presence of a recurrence element
119- (NSArray *)reminders;
120- (void)setReminders:(NSArray *)array;
121- (void)addReminder:(GDataReminder *)obj;
122
123- (NSArray *)recurrenceReminders;
124- (void)setRecurrenceReminders:(NSArray *)array;
125- (void)addRecurrenceReminder:(GDataReminder *)obj;
126
127- (NSArray *)nonRecurrenceReminders;
128- (void)setNonRecurrenceReminders:(NSArray *)array;
129- (void)addNonRecurrenceReminder:(GDataReminder *)obj;
130
131- (GDataEventStatus *)eventStatus;
132- (void)setEventStatus:(GDataEventStatus *)eventStatus;
133
134- (GDataTransparency *)transparency;
135- (void)setTransparency:(GDataTransparency *)str;
136
137- (GDataVisibility *)visibility;
138- (void)setVisibility:(GDataVisibility *)str;
139
140- (NSArray *)times;
141- (void)setTimes:(NSArray *)array;
142- (void)addTime:(GDataWhen *)obj;
143
144- (NSArray *)participants;
145- (void)setParticipants:(NSArray *)array;
146- (void)addParticipant:(GDataWho *)obj;
147
148- (NSArray *)locations;
149- (void)setLocations:(NSArray *)array;
150- (void)addLocation:(GDataWhere *)obj;
151@end
152
153#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_CALENDAR_SERVICE