Inheritance diagram for Facade::IWorkgroupStoryFacade:

Public Types
enum	{ kDefaultIID = IID_IWORKGROUPSTORYFACADE }

Public Member Functions
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

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

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

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

virtual ErrorCode	Relock (UIDRef storyRef)=0

virtual ErrorCode	SaveModelChanges (UIDRef storyRef)=0

virtual bool	IsEditingAllowed (UIDRef storyRef)=0

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode Facade::IWorkgroupStoryFacade::AllowUserEditing	(	const UIDRef &	storyRef,
		ICommand::Undoability	undoabilityFlag = `ICommand::kRegularUndo`
	)

pure virtual

Allows user to edit the story model. IMPORTANT: This method should only be called within an abortable command sequence.

virtual UIDRef Facade::IWorkgroupStoryFacade::GetAssetUIDRef ( UIDRef storyRef )

pure virtual

This method retrieves the UIDRef of the boss that has the IManageableAsset interface from the UIDRef of a story page item.

Parameters

storyRef is the UIDRef of the story page item.

Returns: UIDRef of the IManageableAsset if storyRef is valid; otherwise UIDRef::gNull.

virtual bool16 Facade::IWorkgroupStoryFacade::GetCheckedOutToName	(	const UIDRef &	storyRef,
		PMString &	outCheckedOutToName
	)

pure virtual

Retrieves the user name that a story is checked out to.

Parameters

storyRef	the UIDRef of a story page item.
outCheckedOutToName	a PMString reference to receive the user name.

Returns: kTrue if the story is currently locked (checked out by anyone) and outCheckedOutToName is populated with the user name; otherwise returns kFalse and outCheckedOutToName is not affected.

virtual bool16 Facade::IWorkgroupStoryFacade::GetStoryLockNames	(	UIDRef	storyRef,
		PMString &	outUserName,
		PMString &	outDocName,
		PMString &	outAppName
	)

pure virtual

This method retrieves the story lock status names.

Parameters

storyRef	is the UIDRef of the story page item.
outUserName	is populated with the IManagedStatus::enCheckedOutBy name.
outDocName	is populated with the IManagedStatus::enCheckedOutDoc name.
outAppName	is populated with the IManagedStatus::enCheckedOutApp name.

Returns: kTrue if the names were found (one or more PMStrings may be empty signifying a blank); otherwise, returns kFalse.

virtual bool16 Facade::IWorkgroupStoryFacade::GetStoryLockNames	(	const IDFile &	storyFile,
		PMString &	outUserName,
		PMString &	outDocName,
		PMString &	outAppName,
		UIFlags	uiFlags = `kFullUI`
	)

pure virtual

This method retrieves the story lock status names for a storyFile. This method will succeed only if the story asset is locked.

Parameters

storyFile	has a valid path to an existing file-based story asset.
outUserName	is populated with the IManagedStatus::enCheckedOutBy name.
outDocName	is populated with the IManagedStatus::enCheckedOutDoc name.
outAppName	is populated with the IManagedStatus::enCheckedOutApp name.
uiFlags	controls UI that may be displayed to get the user name.

Returns: kTrue if the names were found (one or more PMStrings may be empty signifying a blank); otherwise, returns kFalse.

virtual IAMLockable::LockState Facade::IWorkgroupStoryFacade::GetStoryLockState	(	UIDRef	storyRef,
		bool16	doVerification = `kFalse`,
		UIFlags	uiFlags = `kFullUI`
	)

pure virtual

This method retrieves the LockState for a story asset.

Parameters

storyRef	is the UIDRef of the story page item.
doVerification	(see description in IWorkgroupFacade::GetLockState).

Returns: the IAMLockable::LockState.

virtual UIDRef Facade::IWorkgroupStoryFacade::GetStoryUIDRef ( UIDRef assetRef )

pure virtual

This method retrieves the UIDRef of the first story page item found to be associated with the specified assetRef.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: UIDRef of the story page item if assetRef is associated with an existing story page item; otherwise UIDRef::gNull.

virtual bool Facade::IWorkgroupStoryFacade::IsEditingAllowed ( UIDRef storyRef )

pure virtual

Tests if a story model can be edited.

Parameters

storyRef is the UIDRef of a story model.

Returns: true if the story model can be edited; false otherwise.

virtual bool16 Facade::IWorkgroupStoryFacade::IsVersioned ( UIDRef storyRef )

pure virtual

This method tests if a story is a versioned asset.

Parameters

storyRef is the UIDRef of the story page item.

Returns: kTrue if versioned; kFalse if not.

virtual bool16 Facade::IWorkgroupStoryFacade::IsWriteable ( const IDFile & storyFile )

pure virtual

This method uses IAMServiceProvider::IsWriteable to test if a story file may be overwritten (exported to).

Parameters

storyFile has a valid path to file-based story asset.

Returns: kTrue if it is currently legal to export to the storyFile; kFalse otherwise.

virtual PMString Facade::IWorkgroupStoryFacade::LiveEditConflictAlert	(	UIDRef	storyRef,
		const IDFile &	storyFile,
		const PMString &	checkedOutBy,
		const PMString &	checkedOutApp,
		const PMString &	checkedOutDoc,
		const PMString &	warnText
	)

pure virtual

This method displays a LiveEdit lock conflict alert for a story.

Parameters

storyRef	is the UIDRef of the story page item affected by the lock conflict.
storyFile	is a valid IDFile if the story asset is file-based; specify an IDFile with an empty path for a story asset that is not file-based.
checkedOutBy	is the name of the user that owns the lock.
checkedOutApp	is the name of the application that owns the lock.
checkedOutDoc	is the name of the document that owns the lock.
warnText	is the text to display.

Returns: one of the LiveEdit alert choices (see kInCopyAlertChoiceYes, et al. in InCopyBridgeUIID.h).

virtual ErrorCode Facade::IWorkgroupStoryFacade::PreventUserEditing	(	const UIDRef &	storyRef,
		ICommand::Undoability	undoabilityFlag = `ICommand::kRegularUndo`
	)

pure virtual

Prevents changes to a story page item by locking the page item for further updates. When this method returns successfully, the content of a story page item may not be changed until the ILiveEditUtils::AllowUserEditing() method is called. IMPORTANT: This method should only be called within an abortable command sequence.

virtual UIDRef Facade::IWorkgroupStoryFacade::QueryStandaloneStoryRef ( UIDRef docRef )

pure virtual

This method retrieves the story UIDRef from a standalone InCopy document.

Parameters

docRef is the UIDRef of an InDesign document.

Returns: UIDRef of the story.

virtual ErrorCode Facade::IWorkgroupStoryFacade::Relink	(	UIDRef	storyRef,
		UIFlags	uiFlags = `kMinimalUI`
	)

pure virtual

This method changes the data link information for an existing story page item.

Parameters

storyRef	is the UIDRef of the story page item.
uiFlags	controls UI that may be displayed to perform the relink.

Returns: kSuccess if the relink succeeded; otherwise returns an ErrorCode value.

virtual ErrorCode Facade::IWorkgroupStoryFacade::Relock ( UIDRef storyRef )

pure virtual

This method updates the IAMLockable implementation for a story asset lock. Note that this method does not affect the story text frame lock.

Parameters

storyRef is the UIDRef of the story page item associated with the story asset to relock.

Returns: kSuccess if the relock operation succeeded; otherwise returns an ErrorCode value.

virtual ErrorCode Facade::IWorkgroupStoryFacade::SaveModelChanges ( UIDRef storyRef )

pure virtual

Writes story model changes to the corresponding story asset using the asset's ISaveAssetContent implementation.

Parameters

storyRef is the UIDRef of a story item.

Returns: kSuccess if the save operation succeeded; otherwise returns an ErrorCode value.

Public Types

Public Member Functions

Member Function Documentation