/* Copyright (c) 2007 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//
//  GDataEntryDocBase.h
//

#if !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_DOCS_SERVICE

#import "GDataEntryBase.h"
#import "GDataFeedLink.h"
#import "GDataDocConstants.h"

@interface GDataEntryDocBase : GDataEntryBase

+ (id)documentEntry;

// extensions
- (GDataDateTime *)lastViewed;
- (void)setLastViewed:(GDataDateTime *)dateTime;

- (GDataDateTime *)sharedWithMe;
- (void)setSharedWithMe:(GDataDateTime *)dateTime;

- (GDataDateTime *)lastModifiedByMe;
- (void)setLastModifiedByMe:(GDataDateTime *)dateTime;

- (NSNumber *)writersCanInvite; // bool
- (void)setWritersCanInvite:(NSNumber *)num;

- (GDataPerson *)lastModifiedBy;
- (void)setLastModifiedBy:(GDataPerson *)obj;

- (NSNumber *)quotaBytesUsed; // long long
- (void)setQuotaBytesUsed:(NSNumber *)num;

- (NSString *)documentDescription;
- (void)setDocumentDescription:(NSString *)str;

- (NSString *)MD5Checksum;
- (void)setMD5Checksum:(NSString *)str;

- (NSString *)filename;
- (void)setFilename:(NSString *)str;

- (NSString *)suggestedFilename;
- (void)setSuggestedFilename:(NSString *)str;

- (GDataDateTime *)lastCommented;
- (void)setLastCommented:(GDataDateTime *)str;

- (NSNumber *)changestamp; // long long
- (void)setChangestamp:(NSNumber *)num;

- (BOOL)isRemoved;
- (void)setIsRemoved:(BOOL)flag;

- (BOOL)hasPathToRoot;
- (void)setHasPathToRoot:(BOOL)flag;

// categories
- (BOOL)isStarred;
- (void)setIsStarred:(BOOL)flag;

- (BOOL)isHidden;
- (void)setIsHidden:(BOOL)flag;

- (BOOL)isViewed;
- (void)setIsViewed:(BOOL)flag;

- (BOOL)isShared;
- (void)setIsShared:(BOOL)flag;

// convenience accessors
- (NSArray *)parentLinks;

- (GDataLink *)thumbnailLink;

// An alternate self link. Used only in GDataEntryDocBase subclasses that
// appear in GDataFeedDocChange. The value is the selfLink of the
// GDataEntryDocBase.
- (GDataLink *)alternateSelfLink;

- (GDataFeedLink *)ACLFeedLink;
- (GDataFeedLink *)revisionFeedLink;

@end

#endif // !GDATA_REQUIRE_SERVICE_INCLUDES || GDATA_INCLUDE_DOCS_SERVICE