#include <IWorkgroupUIFacade.h>

Inheritance diagram for IWorkgroupUIFacade:

Public Types
enum	{ kDefaultIID = IID_IWORKGROUPUIFACADE }

Public Member Functions
virtual IAMUIService::FollowupAction	DoConflictAlert (UIDRef assetRef)=0

virtual IAMUIService::FollowupAction	DoGetBatchVersionComments (UIDList &inAssetList, PMString &outCheckinComment)=0

virtual IAMUIService::FollowupAction	DoGetBatchVersionComments (const IDFile &inFolder, int32 numberOfAssets, PMString &outCheckinComment)=0

virtual IAMUIService::FollowupAction	DoGetVersionComments (UIDRef assetRef, PMString &outCheckinComment)=0

virtual IAMUIService::FollowupAction	DoRevertAlert (UIDRef assetRef)=0

virtual IAMUIService::FollowupAction	DoSaveACopyDialog (const IDFile &inCopyFile, bool16 inUseSystemDefaultDir, IDFile &outSaveFile, bool16 &outSaveAsStationery)=0

virtual IAMUIService::FollowupAction	DoSaveAlert (UIDRef assetRef, const PMString &docName, bool16 allowCancel)=0

virtual IAMUIService::FollowupAction	DoSaveAsDialog (UIDRef assetRef, const IDFile &inDefaultFile, bool16 inUseSystemDefaultDir, IDFile &outSaveFile, bool16 &outSaveAsStationery)=0

virtual IAMUIService::FollowupAction	DoSaveMultipleLinkAlert (UIDList &inAssetList)=0

virtual PMRsrcID	GetStatusIconID (UIDRef assetRef, int32 statusType)=0

virtual bool16	GetStatusString (UIDRef assetRef, int32 statusType, PMString &outString)=0

virtual bool16	IsCommandEnabled (UIDRef assetRef, int32 commandID)=0

virtual bool16	IsCommandEnabled (const ILink *iLink, int32 commandID)=0

virtual IAMUIService::FollowupAction	ViewVersions (UIDRef assetRef, IDFile &outTempVersion)=0

virtual IAMUIService::FollowupAction	DoSaveAsDialog2 (UIDRef assetRef, const IDFile &inDefaultFile, bool16 inUseSystemDefaultDir, IDFile &outSaveFile, bool16 &outSaveAsStationery, bool16 inShouldSuppressIDMLSave=kFalse)=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

The IWorkgroupUIFacade provides high-level access to the public AMSP interfaces for displaying UI. Suggested usage:

Utils<IWorkgroupUIFacade>()->method( params,... );

Member Function Documentation

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoConflictAlert ( UIDRef assetRef )

pure virtual

This method invokes a IAMUIServiceProvider::enConflictAlert service.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: the followup action as defined for IAMUIServiceProvider::enConflictAlert.

See Also: IAMUIServiceProvider.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoGetBatchVersionComments	(	UIDList &	inAssetList,
		PMString &	outCheckinComment
	)

pure virtual

This method invokes an IAMUIServiceProvider::enGetBatchVersionComments service to get a single checkin comment for a list of UIDRefs.

Parameters

inAssetList	is a UIDList of UIDRef for IManageableAssets.
outCheckinComment	is populated with the comment text (empty string is a valid blank comment).

Returns: the followup action as defined for IAMUIServiceProvider::enGetBatchVersionComments.

See Also: IAMUIServiceProvider.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoGetBatchVersionComments	(	const IDFile &	inFolder,
		int32	numberOfAssets,
		PMString &	outCheckinComment
	)

pure virtual

This method invokes an IAMUIServiceProvider::enGetBatchVersionComments service to get a single checkin comment for the files in a folder. This is an alternative way to get batch version comments when individual asset UIDRefs do not exist or asset files have not yet been created.

Parameters

infolder	is an IDFile with a valid path to a folder.
numberOfAssets	is the number of asset files to check in.
outCheckinComment	is populated with the comment text (empty string is a valid blank comment).

Returns: the followup action as defined for IAMUIServiceProvider::enGetBatchVersionComments.

See Also: IAMUIServiceProvider.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoGetVersionComments	(	UIDRef	assetRef,
		PMString &	outCheckinComment
	)

pure virtual

This method invokes an IAMUIServiceProvider::enGetVersionComments service to get checkin comments for a single asset.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
outCheckinComment	is populated with the comment text (empty string is a valid blank comment).

Returns: the followup action as defined for IAMUIServiceProvider::enGetVersionComments.

See Also: IAMUIServiceProvider.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoRevertAlert ( UIDRef assetRef )

pure virtual

This method invokes an IAMUIServiceProvider::enRevertAlert service.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: the followup action as defined for IAMUIServiceProvider::enRevertAlert.

See Also: IAMUIServiceProvider.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoSaveACopyDialog	(	const IDFile &	inCopyFile,
		bool16	inUseSystemDefaultDir,
		IDFile &	outSaveFile,
		bool16 &	outSaveAsStationery
	)

pure virtual

This method invokes an IAMUIServiceProvider::enSaveACopyDialog service.

Parameters

inCopyFile	is an IDFile with the default copy filename.
inUseSystemDefaultDir	if kTrue, initialize the dialog to the system default directory.
outSaveFile	is the IDFile to save to.
outSaveAsStationery	is the save option.

Returns: the followup action as defined for IAMUIServiceProvider::enSaveACopyDialog.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoSaveAlert	(	UIDRef	assetRef,
		const PMString &	docName,
		bool16	allowCancel
	)

pure virtual

This method invokes an IAMUIServiceProvider::enSaveAlert service.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
docName	is the document name to place in the alert message.
allowCancel	displays a Cancel button when kTrue.

Returns: the followup action as defined for IAMUIServiceProvider::enSaveAlert.

See Also: IAMUIServiceProvider.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoSaveAsDialog	(	UIDRef	assetRef,
		const IDFile &	inDefaultFile,
		bool16	inUseSystemDefaultDir,
		IDFile &	outSaveFile,
		bool16 &	outSaveAsStationery
	)

pure virtual

This method invokes an IAMUIServiceProvider::enSaveAsDialog service.

Parameters

assetRef	is a UIDRef for the IManageableAsset to be saved.
inDefaultFile	initializes the dialog to this file path.
inUseSystemDefaultDir	if kTrue, initialize the dialog to the system default directory.
outSaveFile	is the IDFile to save to.
outSaveAsStationery	is the save option.

Returns: the followup action as defined for IAMUIServiceProvider::enSaveAsDialog.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoSaveAsDialog2	(	UIDRef	assetRef,
		const IDFile &	inDefaultFile,
		bool16	inUseSystemDefaultDir,
		IDFile &	outSaveFile,
		bool16 &	outSaveAsStationery,
		bool16	inShouldSuppressIDMLSave = `kFalse`
	)

pure virtual

This method invokes an IAMUIServiceProvider::enSaveAsDialog service.

Parameters

assetRef	is a UIDRef for the IManageableAsset to be saved.
inDefaultFile	initializes the dialog to this file path.
inUseSystemDefaultDir	if kTrue, initialize the dialog to the system default directory.
outSaveFile	is the IDFile to save to.
outSaveAsStationery	is the save option.
inShouldSuppressIDMLSave	if kTrue, option of Save as IDML is suppressed

Returns: the followup action as defined for IAMUIServiceProvider::enSaveAsDialog.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::DoSaveMultipleLinkAlert ( UIDList & inAssetList )

pure virtual

This method invokes an IAMUIServiceProvider::enSaveMultiLinkAlert service.

Parameters

inAssetList is a list of UIDRefs for IManageableAssets.

Returns: the followup action as defined for IAMUIServiceProvider::enSaveMultiLinkAlert.

See Also: IAMUIServiceProvider.

virtual PMRsrcID IWorkgroupUIFacade::GetStatusIconID	(	UIDRef	assetRef,
		int32	statusType
	)

pure virtual

This method retrieves the IManagedStatus display icon for an IManageableAsset.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
statusType	is a predefined IManagedStatus::WGStatusType or other unique identifier.

Returns: a RsrcID or 0 if statusType not found.

See Also: IManagedStatus.

virtual bool16 IWorkgroupUIFacade::GetStatusString	(	UIDRef	assetRef,
		int32	statusType,
		PMString &	outString
	)

pure virtual

This method retrieves the IManagedStatus status display string for an IManageableAsset.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
statusType	is a predefined IManagedStatus::WGStatusType or other unique identifier.
outString	is populated with the status text.

Returns: kTrue if statusType was found, kFalse otherwise.

See Also: IManagedStatus.

virtual bool16 IWorkgroupUIFacade::IsCommandEnabled	(	UIDRef	assetRef,
		int32	commandID
	)

pure virtual

This method accesses the IAMUIEnablementRules for an IManageableAsset to determine if a UI command should be enabled.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
commandID	is a predefined IAMUIEnablementRules::WGUICommandID or any unique integer.

Returns: kTrue if enabled; kFalse if not.

See Also: IAMUIEnablementRules.

virtual bool16 IWorkgroupUIFacade::IsCommandEnabled	(	const ILink *	iLink,
		int32	commandID
	)

pure virtual

This method determines if a Link UI workgroup command should be enabled.

Parameters

iLink	is a pointer to an ILink instance.
commandID	is a predefined IAMUIEnablementRules::WGUICommandID or any unique integer.

Returns: kTrue if enabled; kFalse if not.

See Also: IAMUIEnablementRules.

virtual IAMUIService::FollowupAction IWorkgroupUIFacade::ViewVersions	(	UIDRef	assetRef,
		IDFile &	outTempVersion
	)

pure virtual

This method invokes an IAMUIServiceProvider::enViewVersions service.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
outTempVersion	if the followup action is IAMUIService::enOpenFile, this is an IDFile with a valid path to a temporary file of the version to open for viewing.

Returns: the followup action as defined for IAMUIServiceProvider::enViewVersions.

See Also: IAMUIServiceProvider.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation