IInCopyBridgeUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IInCopyBridgeUtils__
#define __IInCopyBridgeUtils__

#include "InCopyBridgeID.h"
#include "IPMUnknown.h"

#include "K2Vector.h"
#include "ICommand.h"

class ICommand;
class UIDRef;
class PMString;
class IDataLink;
class IDocument;

// DEPRECATED. DO NOT USE THIS INTERFACE.
// See method descriptions below for suggested alternative methods to use.

class IInCopyBridgeUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IINCOPYBRIDGEUTILS };

 enum ICBridgeError
 {
 // ARM's _ExpectedErrors, see ARMTypes.h .
 //kSuccess = 0,
 //kCancelled = 1,
 //kUnauthorized,
 //kNoSuchResource,
 //kNoContent,
 //kPermissionDenied,
 //kLockedElsewhere,
 //kLockedByOther,
 //kLockedExclusively,
 //kLockedShared,
 //kLockRevoked,
 //kNoSuchReplica,
 //kWouldClobberLocked,
 //kWouldClobberModified,
 //kWouldClobberCurrent,
 //kNoSuchParent,
 //kNoMountPoint,
 //kCantMountParent,
 //kCantMountChild,
 //kMountPointsDiffer,
 //kNotInARM,
 //kCollectionAlreadyExists,
 //kNonCollectionAlreadyExists,
 //kCantCaptureUnlessCurrent,
 //kLastExpectedError = 0x7FFFFFFF, // force enum to be a 32 bit int

 //kIllegalURL = -6666, /* a distinctive number, for luck! */
 //kForbidden,
 //kServerBusy,
 //kRedirect,
 //kServerFailure,
 //kDatabaseFailure,
 //kDiskFailure,
 //kMemoryFailure,
 //kNetworkFailure,
 //kConfigurationError,
 //kClientNameError,
 //kRequestError,
 //kFileOpenFailure,
 //kBadParameterPassed,
 //kCantFindMountPointFolder,
 //kFileNotFound,
 //kFolderNotFound,
 //kItemWasNotAFolder,
 //kCantResolveAlias,
 //kCantOpenOptionsFile,
 //kCantCreateAlias,
 //kCantOpenResourceFork,
 //kFileAlreadyExists,
 //kNoMountPointRoot,
 //kIllegalMountName,
 //kNotDAVResource, // server return shows protocol failure
 //kResourceMissing, // didn't find a resource we expected
 //kCantCreateFolder,
 //kEncodingError, // can't map characters
 //kMountPointRootMissing, // the mount point root was expected but couldn't be found
 //kNonSpecific = -1,
 //kLastUnexpectedError = 0x7FFFFFFF, // force enum to be a 32 bit int
 //
 
 // InCopyBridge errors
 kNoError = kICBErr_NoError,
 kUnknown = kICBErr_Unknown,
 kInvalidParameter = kICBErr_InvalidParameter,
 kNoDataLink = kICBErr_NoDataLink,
 kBrokenLink = kICBErr_BrokenLink,
 kLinkIsEmbedded = kICBErr_LinkIsEmbedded,
 kNotNormalLink = kICBErr_NotNormalLink,
 kCantGetLinkFile = kICBErr_CantGetLinkFile,
 kInvalidUserName = kICBErr_kInvalidUserName,
 kLinkIsMissing = kICBErr_kLinkIsMissing,
 kLastInCopyBridgeError = kLinkIsMissing
 };

#ifdef ID_DEPRECATED

 virtual void SetInCopyUsername( const PMString& userName ) const = 0;

 virtual PMString GetInCopyUsername( UIFlags uiFlags = kFullUI ) const = 0;


 virtual IDataLink *QueryDataLink( const UIDRef& storyRef ) const = 0;


 virtual bool16 LockTextModel( const UIDRef& storyRef, bool16 lockStory, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo ) const = 0;


 virtual bool16 LockItem( const UIDRef& itemRef, bool16 lock, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo ) const = 0;


 virtual ErrorCode NotifyResponders( ICommand *icBridgeCommand, ServiceID serviceID = kLiveEditCmdResponderService ) const = 0;


 virtual bool16 GetInCopyLockFile( const IDFile& storySysFile, IDFile& inCopyLockFile ) const = 0;


 virtual bool16 SyncTextModelLock( const UIDRef& storyRef, IDFile& storyFile, UIFlags uiFlags = kFullUI ) const = 0;

 virtual bool16 SetTextModelLock( const UIDRef& storyRef ) const = 0;
 
 virtual bool16 IsInCopyStory( const UIDRef& storyRef ) const = 0; 


 virtual bool16 GetSysFileOfStory( const UIDRef& storyRef, IDFile& storyFile, FileTypeInfoID& fileTypeInfo, ICBridgeError* errorCode = nil, bool16 allowSynchronous = kTrue ) const = 0;


 virtual PMString GetGUIDOfStory( const UIDRef& storyRef, bool16 createGUIDifNecessary = kTrue ) const = 0;
 
 virtual bool16 AreStoriesLocked( const IDocument* document, bool16 useCachedValue = kFalse ) const = 0;

 virtual bool16 ExportStory( const UIDRef& storyRef, const IDFile& storyFile, const FileTypeInfoID fileTypeID ) const = 0;
 
#endif // ID_DEPRECATED

};


#endif // __IInCopyBridgeUtils__