IWorkgroupStoryFacade.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 __IWORKGROUPSTORYFACADE__
#define __IWORKGROUPSTORYFACADE__

#include "workgroupid.h"
#include "Utils.h"
#include "IPMUnknown.h"

#include "IAMLockable.h"

namespace Facade
{
 class IWorkgroupStoryFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IWORKGROUPSTORYFACADE };
 
 virtual ErrorCode AllowUserEditing( const UIDRef & storyRef, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo ) = 0;
 
 virtual UIDRef GetAssetUIDRef( UIDRef storyRef ) = 0;

 virtual bool16 GetCheckedOutToName( const UIDRef& storyRef, PMString & outCheckedOutToName ) = 0;

#ifdef ID_DEPRECATED

 virtual bool16 GetStoryFile( const UIDRef& storyRef, IDFile& outStoryFile ) = 0;
#endif // ID_DEPRECATED

 virtual UIDRef GetStoryUIDRef( UIDRef assetRef ) = 0;
 
 virtual bool16 GetStoryLockNames( UIDRef storyRef, PMString & outUserName, PMString & outDocName, PMString & outAppName ) = 0;

 virtual bool16 GetStoryLockNames( const IDFile & storyFile, PMString & outUserName, PMString & outDocName, PMString & outAppName, UIFlags uiFlags = kFullUI ) = 0;
 
 virtual IAMLockable::LockState GetStoryLockState( UIDRef storyRef, bool16 doVerification = kFalse, UIFlags uiFlags = kFullUI ) = 0;

#ifdef ID_DEPRECATED

 virtual bool16 IsAStory( UIDRef testRef ) = 0;
#endif // ID_DEPRECATED

#ifdef ID_DEPRECATED 

 virtual bool16 IsEmbedded( UIDRef storyRef ) = 0;
#endif // ID_DEPRECATED

 virtual bool16 IsVersioned( UIDRef storyRef ) = 0;

 virtual bool16 IsWriteable( const IDFile & storyFile ) = 0;

 virtual PMString LiveEditConflictAlert( UIDRef storyRef, const IDFile& storyFile, const PMString& checkedOutBy, const PMString& checkedOutApp, const PMString& checkedOutDoc, const PMString& warnText ) = 0;

 virtual ErrorCode PreventUserEditing( const UIDRef & storyRef, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo ) = 0;
 
 virtual UIDRef QueryStandaloneStoryRef( UIDRef docRef ) = 0;

#ifdef ID_DEPRECATED 

 virtual ErrorCode SyncStoryPIAccessToStoryLock( UIDRef storyRef ) = 0;
#endif // ID_DEPRECATED 

 virtual ErrorCode Relink( UIDRef storyRef, UIFlags uiFlags = kMinimalUI ) = 0;

#ifdef ID_DEPRECATED 

 virtual ErrorCode Unembed( UIDRef storyRef, UIFlags uiFlags = kFullUI, ICommand::Undoability undoabilityFlag = ICommand::kRegularUndo ) = 0;
#endif // ID_DEPRECATED

 virtual ErrorCode Relock( UIDRef storyRef ) = 0;
 
 virtual ErrorCode SaveModelChanges( UIDRef storyRef ) = 0;
 
 virtual bool IsEditingAllowed( UIDRef storyRef ) = 0;
 
 }; // end IWorkgroupStoryFacade interface
}

#endif // __IWORKGROUPSTORYFACADE__