IWorkgroupFacade.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 __IWORKGROUPFACADE__
#define __IWORKGROUPFACADE__

#include "workgroupid.h"
#include "IPMUnknown.h"
#include "IAMLockable.h"
#include "IAMServiceProvider.h"
#include "IDatalink.h"
#include "IManageableAsset.h"
#include "IOpenFileCmdData.h"
#include "Utils.h"

class IDFile;
class SysFileList;
class URIList;

namespace Facade
 {
 class IWorkgroupFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IWORKGROUPFACADE };

 typedef std::vector<IDFile> FileList;
 
 enum ForceSave
 {
 enForceSaveYes,
 enForceSaveNo,
 enForceSaveUnspecified
 };

 virtual void AddRestoreCheckedOutCandidate( UIDRef assetRef, UID objectUID = kInvalidUID ) = 0;
 
 virtual void AddRestoreLinkCandidate( UIDRef assetRef ) = 0;

 virtual void AddRestoreLockStateCandidate( UIDRef assetRef, int32 assetServiceID, UID objectUID = kInvalidUID, const PMString *userName = nil ) = 0;
 
 virtual ErrorCode AddStatusListener( UIDRef listenerRef, UIDRef assetRef ) = 0;
 
 virtual bool16 AssetHasMoved( UIDRef assetRef ) = 0;
 
 virtual ErrorCode CancelCheckOut( UIDRef assetRef, UIFlags uiFlags = kFullUI, const PMString *checkOutToUserName = nil, UID objectUID = kInvalidUID ) = 0;

 virtual bool16 CanCheckIn( UIDRef assetRef, UID objectUID = kInvalidUID ) = 0;

 virtual bool16 CanCheckOut( UIDRef assetRef, UID objectUID = kInvalidUID ) = 0;
 
 virtual bool16 CanRevert( UIDRef assetRef, UID objectUID = kInvalidUID ) = 0;
 
 virtual bool16 CanSaveToSource( UIDRef assetRef ) = 0;

 virtual bool16 CanTerminateAssetManagement( UIDRef assetRef ) = 0;

 virtual ErrorCode CheckIn( UIDRef assetRef, bool16 doSaveChanges, const PMString * versionComment = nil, UIFlags uiFlags = kFullUI, bool16 doSaveVersion = kTrue, const PMString *checkedOutToUserName = nil, UID objectUID = kInvalidUID ) = 0;
 
 virtual ErrorCode CheckIn( const IDFile& assetFile, const PMString * versionComment = nil, const IWorkgroupFacade::ForceSave& forceSave = IWorkgroupFacade::enForceSaveUnspecified ) = 0;
 
 virtual ErrorCode CheckIn( const IWorkgroupFacade::FileList & inIDFileList, const PMString & inComment ) = 0;

 virtual ErrorCode CheckIn( const UIDList & inLinkResources, UIFlags uiFlags = kFullUI ) = 0;
 
 virtual ErrorCode CheckOut( UIDRef assetRef, UIFlags uiFlags = kFullUI, const PMString *checkOutToUserName = nil, UID objectUID = kInvalidUID ) = 0;
 
 virtual ErrorCode EnsureLatestVersion( const IDFile & file ) = 0; 
 
 virtual ErrorCode EnsureLatestVersion( IDataLink * dl ) = 0;

 virtual ErrorCode EnsureLatestVersion( UIDRef assetRef ) = 0;
 
 virtual void GetCurrentUserName( UIDRef assetRef, PMString & outCurrentUserName ) = 0;

 virtual IManagedStatus::EditingState GetEditingState( UIDRef assetRef ) = 0;
 
 virtual IAMLockable::LockState GetLockState( UIDRef assetRef, bool16 doVerification = kFalse, UIFlags uiFlags = kFullUI, UID objectUID = kInvalidUID ) = 0;
 
 virtual void GetStatusString( UIDRef assetRef, int32 wgStatusID, PMString & outStatusStr ) = 0;
 
 virtual ErrorCode GetUniqueAssetLocation( const IDFile & inProposedFile, IDFile & outUniqueFile ) = 0;

 virtual UIFlags GetUserInteractionLevel() = 0;
 
 virtual IManagedStatus::VersionState GetVersionState( UIDRef assetRef ) = 0;
 
 virtual bool16 HasVersionedContent( UIDRef assetRef ) = 0;

 virtual ErrorCode InitDocumentAssetManagement( UIDRef assetRef, const IDFile & file = IDFile() ) = 0;
 
 virtual ErrorCode InitLinkAssetManagement( UIDRef assetRef, bool16 useStoredAssetManagementData = kFalse ) = 0;
 
 virtual ErrorCode InitWithoutAssetManagement( UIDRef assetRef ) = 0;
 
 virtual ErrorCode InvalidateProxyVersionNumber( IDataLink * dl ) = 0;

 virtual ErrorCode InvalidateProxyVersionNumber( UIDRef assetRef ) = 0;
 
 virtual bool16 IsAssetManagementInitialized( UIDRef assetRef ) = 0;
 
 virtual bool16 IsCheckedOut( UIDRef assetRef, UID objectUID = kInvalidUID ) = 0;
 
 virtual bool16 IsLatestVersion( UIDRef assetRef ) = 0;

 virtual bool16 IsLockable( UIDRef assetRef ) = 0;
 
 virtual bool16 IsNewerVersionAvailable( UIDRef assetRef ) = 0;
 
 virtual bool16 IsOnline( UIDRef assetRef ) = 0;
 
 virtual bool16 IsTemporaryVersion( const IDFile & file ) = 0;
 
 virtual bool16 IsVersioned( UIDRef assetRef ) = 0;
 
 virtual bool16 IsVersioned( const IDFile & file ) = 0;
 
 virtual bool16 IsWriteable( UIDRef assetRef ) = 0;
 
 virtual IDataLink::StateType OverrideLinkState( UIDRef assetRef, IDataLink::StateType localState ) = 0;

 virtual IOpenFileCmdData::OpenFlags OverrideOpenFlags( const IDFile & file, IOpenFileCmdData::OpenFlags inOpenFlags ) = 0;

 virtual ErrorCode RemoveStatusListener( UIDRef listenerRef, UIDRef assetRef ) = 0;

 virtual void RestoreUserInteractionLevel() = 0;
 
 virtual bool16 RetrieveCheckInComment( const IDFile & file, PMString & outComment ) = 0;

 virtual ForceSave RetrieveForceSaveOption( const IDFile& file ) = 0;
 
 virtual ErrorCode Revert( UIDRef assetRef ) = 0;
 
 virtual ErrorCode StartMonitoring( UIDRef assetRef ) = 0;
 
 virtual ErrorCode StopMonitoring( UIDRef assetRef ) = 0;

 virtual void StoreCheckInComment( const PMString & inComment, const IDFile & file ) = 0;

 virtual void StoreForceSaveOption( const IDFile& file, const ForceSave& forceSave ) = 0;

 virtual void StoreUserInteractionLevel(const UIFlags& uiFlags) = 0;
 
 virtual ErrorCode TerminateAssetManagement( UIDRef assetRef ) = 0;
 
 virtual ErrorCode UpdateLinkLocation( IDataLink * dl ) = 0;

 virtual ErrorCode UpdateLinkLocation( UIDRef assetRef ) = 0;
 
 virtual ErrorCode UpdateProxyVersionNumber( IDataLink * dl ) = 0;
 
 virtual ErrorCode UpdateProxyVersionNumber( UIDRef assetRef ) = 0;
 
 virtual ErrorCode UpdateScriptedAssetData( UIDRef assetRef, const PMString & scriptString, int32 scriptID ) = 0;
 
 virtual ErrorCode UpdateStoredAssetReference( IDataLink * dl ) = 0;

 virtual ErrorCode UpdateStoredAssetReference( UIDRef assetRef ) = 0;
 
 virtual bool16 IsMonitoring( UIDRef assetRef ) = 0;

 }; // end IWorkgroupFacade interface
}

#endif // __IWORKGROUPFACADE__