#include <IInCopyWorkgroupHelper.h>

Inheritance diagram for IInCopyWorkgroupHelper:

Public Types
enum	{ kDefaultIID = IID_IINCOPYWORKGROUPHELPER }

Public Member Functions
virtual bool16	WorkgroupSyncPreLoad (const IDFile &fileToOpen) const =0

virtual bool16	WorkgroupSyncPrePlace (const IDFile &fileToOpen) const =0

virtual bool16	WorkgroupSyncPreLoad (const UIDRef &story) const =0

virtual bool16	WorkgroupSyncPrePlace (const UIDRef &story) const =0

virtual bool16	ShouldSyncPreLoad (UIDRef story)=0

virtual bool16	ShouldSyncPrePlace (UIDRef story)=0

virtual void	WorkgroupSyncPostSave (const IDFile &theFile) const =0

virtual bool16	HasNewerVersion (const UIDRef &doc)=0

virtual bool16	GetOriginalSysFile (const UIDRef &doc, IDFile &originalSysFile)=0

virtual bool16	IsTemporaryVersion (const UIDRef &doc)=0

virtual UIDRef	GetCurrentVersionDoc (const UIDRef &doc, const IDFile &destFile)=0

virtual void	SetWorkgroupSaveAsData (const UIDRef &doc)=0

virtual bool16	IsVersioned (const UIDRef &doc) const =0

virtual bool16	IsVersionedLocation (const IDFile &theFile) const =0

virtual bool16	ShouldSaveAsAlternate (const UIDRef &doc, IDFile &originalPath) const =0

virtual int32	MakeAlternate (const IDFile versionSysFile, const IDFile originalReplicaSysFile) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

FOR INTERNAL USE. This interface is provided to give source code delivered via the sdk (i.e InCopyFileActions,InCopyDocUtils) access to private workgroup methods.

Member Function Documentation

virtual UIDRef IInCopyWorkgroupHelper::GetCurrentVersionDoc	(	const UIDRef &	doc,
		const IDFile &	destFile
	)

pure virtual

Called from IInCopyDocUtils::DoSaveAs() to see if the current version is open such that it can be silently closed in order to save the temporary version to the same location. Method will check for IsStandAloneDoc and IsTemporaryVersion.

Parameters

doc	the document to test for the temporary version.
destFile	the destination file path.

Returns: UIDRef for the current version corresponding to this temp version if open.

virtual bool16 IInCopyWorkgroupHelper::GetOriginalSysFile	(	const UIDRef &	doc,
		IDFile &	originalSysFile
	)

pure virtual

Called from IInCopyDocUtils::DoSaveAs() to get original sys file for temp version. Method will check for IsStandAloneDoc and IsTemporaryVersion.

Parameters

doc	IN document for which to get the original sysfile.
originalSysFile	OUT the original sysfile.

Returns: bool16 true if the specified doc was stand-alone, temp version and able to get the original version's sysfile.

virtual bool16 IInCopyWorkgroupHelper::HasNewerVersion ( const UIDRef & doc )

pure virtual

Test whether there is a new version of the specified document, used to to determine Update Design enablement.

Parameters

doc	the document to test.

Returns: bool16 true if there is a newer version.

virtual bool16 IInCopyWorkgroupHelper::IsTemporaryVersion ( const UIDRef & doc )

pure virtual

Called from IInCopyDocUtils::ShouldDoSaveAs() to determine if the specified document is a temporary version such that Save should behave as SaveAs. Method will check for IsStandAloneDoc.

Parameters

doc	the document to test.

Returns: bool16 true if specified doc is temporary version.

virtual bool16 IInCopyWorkgroupHelper::IsVersioned ( const UIDRef & doc ) const

pure virtual

Test whether this document needs workgroup version close ui.

Parameters

doc	the document to test.

Returns: bool16 true if IsStandAloneDoc, is managed by version cue and is not a temporary version.Display workgroup ui to save - this is the 4-button save alert - for the specified document.

Parameters

doc	the document to save.

Returns: IDocFileHandler::CloseOptions the user's selection in the save alert.Test whether this document is versioned by version cue.

Parameters

doc	the document to test.

Returns: bool16 true if is standalone and is versioned.

virtual bool16 IInCopyWorkgroupHelper::IsVersionedLocation ( const IDFile & theFile ) const

pure virtual

Test whether this file location is in a version cue project.

Parameters

theFile the file location to test.

Returns: bool16 true if file location versioned.

virtual int32 IInCopyWorkgroupHelper::MakeAlternate	(	const IDFile *	versionSysFile,
		const IDFile *	originalReplicaSysFile
	)		const

pure virtual

Called from IInCopyDocUtils::DoSaveAs() to make the new version an alternate of the specified original version.

Parameters

versionSysFile	the new version file path.
originalReplicaSysFile	the original version file path.

Returns: int32 kSuccess or workgroup error code.

virtual void IInCopyWorkgroupHelper::SetWorkgroupSaveAsData ( const UIDRef & doc )

pure virtual

Sets the workgroup ui data replica monitor so that is can be used in the AWS_CUI_CreateSaveDialog.

Parameters

doc	the document to save as.

virtual bool16 IInCopyWorkgroupHelper::ShouldSaveAsAlternate	(	const UIDRef &	doc,
		IDFile &	originalPath
	)		const

pure virtual

Called from IInCopyDocUtils::DoSaveAs() to test whether the specified document should be saved as alternate - the user checked the Save As Alternate check box in the Save As dialog. Method will verify specified document is standaloneand is versioned.

Parameters

doc	IN document to test.
originalPath	OUT the path of the original replica (that this doc will become an alternate of).

Returns: bool16 true if Save As Alternate was checked.

virtual bool16 IInCopyWorkgroupHelper::ShouldSyncPreLoad ( UIDRef story )

pure virtual

Test whether the specified story is managed by version cue and can be downloaded for open.

Parameters

story to test for a replica path.

Returns: bool16 whether or not story is managed by version cue.

virtual bool16 IInCopyWorkgroupHelper::ShouldSyncPrePlace ( UIDRef story )

pure virtual

Test whether the specified story is managed by version cue and can be downloaded for place.

Parameters

story to test for a replica path.

Returns: bool16 whether or not story is managed by version cue.

virtual void IInCopyWorkgroupHelper::WorkgroupSyncPostSave ( const IDFile & theFile ) const

pure virtual

Version cue post save upload of the specified file.

Parameters

theFile the file to upload.

virtual bool16 IInCopyWorkgroupHelper::WorkgroupSyncPreLoad ( const IDFile & fileToOpen ) const

pure virtual

Downloads the specified file for open if it does not already exist locally.

Parameters

fileToOpen file to download.

Returns: bool16 true if file was successfully downloaded.

virtual bool16 IInCopyWorkgroupHelper::WorkgroupSyncPreLoad ( const UIDRef & story ) const

pure virtual

Downloads the specified story for open if it does not already exist locally.

Parameters

story to download.

Returns: bool16 true if file was successfully downloaded.

virtual bool16 IInCopyWorkgroupHelper::WorkgroupSyncPrePlace ( const IDFile & fileToOpen ) const

pure virtual

Downloads the specified file for place if it does not already exist locally.

Parameters

fileToOpen file to download.

Returns: bool16 true if file was successfully downloaded.

virtual bool16 IInCopyWorkgroupHelper::WorkgroupSyncPrePlace ( const UIDRef & story ) const

pure virtual

Downloads the specified story for place if it does not already exist locally.

Parameters

story to download.

Returns: bool16 true if file was successfully downloaded.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation