ILiveEditFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Bill Tislar
// 
// $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 __ILIVEEDITFACADE__
#define __ILIVEEDITFACADE__

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


class TaskProgressBar;

namespace Facade
 {
 class ILiveEditFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_ILIVEEDITFACADE };

 enum LiveEditError 
 {
 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
 }; 
 
 virtual ErrorCode CancelCheckOut( const UIDList& storyList, bool16 updateStoryLink = kTrue, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo, const PMString *userName = nil, UIFlags uiFlags = kFullUI ) = 0;

 enum CheckInOptions
 {
 enUnlockAsset = 0x00000001,
 enExportStory = 0x00000002,
 enSaveVersion = 0x00000004,
 enKeepUndoStack = 0x00000008, 
 enLast = 0x7FFFFFFF // Force enum to 32 bits
 };
 
 virtual ErrorCode CheckIn( const UIDList& storyList, ILiveEditFacade::CheckInOptions opts = ILiveEditFacade::enUnlockAsset, const PMString * comment = nil, const PMString *userName = nil, ICommand::Undoability undoabilityFlag = ICommand::kAutoUndo, UIFlags uiFlags = kFullUI ) = 0;
 
 virtual ErrorCode CheckOut( const UIDList& storyList, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo, const PMString *userName = nil, bool16 displayConflictAlert = kFalse, UIFlags uiFlags = kFullUI ) = 0;
 
 virtual ErrorCode RelockStories( const UIDList& storyList, UIFlags uiFlags = kFullUI ) = 0;
 
 virtual ErrorCode SaveStories( const UIDList& storyList, UIFlags uiFlags = kFullUI ) = 0;

 virtual ErrorCode SynchronizeLocks( const UIDList& storyList, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo, TaskProgressBar * progressBar = nil, UIFlags uiFlags = kFullUI ) = 0;
 
 virtual ErrorCode UpdateStoryLink( const UIDList& storyList, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo, PMString * commandName = nil, UIFlags uiFlags = kFullUI ) = 0;
 
 }; // end ILiveEditFacade interface



 inline bool IsLiveEditAvailable()
 {
 return Utils<Facade::ILiveEditFacade>() == nil ? false : true;
 }
} // end namespace Facade

#endif // __ILIVEEDITFACADE__