Inheritance diagram for Facade::IWorkgroupFacade:

Public Types
enum	{ kDefaultIID = IID_IWORKGROUPFACADE }

enum	ForceSave { enForceSaveYes, enForceSaveNo, enForceSaveUnspecified }

typedef std::vector< IDFile >	FileList

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

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Enumeration Documentation

enum Facade::IWorkgroupFacade::ForceSave

Predefined ForceSave options for resolving version conflicts during CheckIn.
Enumerator
enForceSaveYes
OK to checkin even though a newer version exists
enForceSaveNo
Do not checkin if a newer version exists
enForceSaveUnspecified
Undecided; display UI for user assistance

Member Function Documentation

virtual void Facade::IWorkgroupFacade::AddRestoreCheckedOutCandidate	(	UIDRef	assetRef,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method adds an assetRef to the list to be restored (reinitialized) as part of an ICommand Undo/Redo checkout operation for LiveEdit.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
objectUID	is the UID of the document model object linked to the asset.

virtual void Facade::IWorkgroupFacade::AddRestoreLinkCandidate ( UIDRef assetRef )

pure virtual

This method adds an assetRef to the list to be restored (reinitialized) as part of an ICommand Undo/Redo operation.

Parameters

assetRef is a UIDRef for an IManageableAsset.

virtual void Facade::IWorkgroupFacade::AddRestoreLockStateCandidate	(	UIDRef	assetRef,
		int32	assetServiceID,
		UID	objectUID = `kInvalidUID`,
		const PMString *	userName = `nil`
	)

pure virtual

todo: add doc++ comments

virtual ErrorCode Facade::IWorkgroupFacade::AddStatusListener	(	UIDRef	listenerRef,
		UIDRef	assetRef
	)

pure virtual

This method adds an IAMStatusListener to an IManagedStatus instance.

Parameters

listenerRef	is the UIDRef of an IAMStatusListener.
assetRef	is a UIDRef for an IManageableAsset.

Returns: ErrorCode if there was an error; otherwise returns kSuccess.

virtual bool16 Facade::IWorkgroupFacade::AssetHasMoved ( UIDRef assetRef )

pure virtual

This method tests if a managed asset has been moved or renamed.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if the asset has been moved or renamed; kFalse otherwise.

virtual ErrorCode Facade::IWorkgroupFacade::CancelCheckOut	(	UIDRef	assetRef,
		UIFlags	uiFlags = `kFullUI`,
		const PMString *	checkOutToUserName = `nil`,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method cancels the checkout of an asset, provided that the local working copy has not been modified. Services executed (in order): IAMServiceProvider::enCancelCheckOut, IAMServiceProvider::enAfterCancelCheckOut.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
uiFlags	specifies the UI permitted during the method execution.
checkOutToUserName	optional parameter that identifies the user that has the asset checked out (default is current user).
objectUID	is the UID of the model object (e.g., page item) associated with the asset.

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

virtual bool16 Facade::IWorkgroupFacade::CanCheckIn	(	UIDRef	assetRef,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method tests if a CheckIn is permitted.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
objectUID	is the UID of the document model object linked to the asset.

Returns: kTrue if it is OK to CheckIn; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::CanCheckOut	(	UIDRef	assetRef,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method tests if a CheckOut is permitted.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
objectUID	is the UID of the document model object linked to the asset.

Returns: kTrue if it is OK to CheckOut; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::CanRevert	(	UIDRef	assetRef,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method tests if an asset's locally-saved changes can be reverted to the current version.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
objectUID	is the UID of the document model object linked to the asset.

Returns: kTrue if it is OK to revert; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::CanSaveToSource ( UIDRef assetRef )

pure virtual

This method tests if changes to an asset can be saved (written) to its source file (the file it was created from).

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if it is OK to write to source file; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::CanTerminateAssetManagement ( UIDRef assetRef )

pure virtual

This method tests if asset management for an asset can be terminated. Normally it is OK to terminate, but this method may return kFalse if the asset status in currently being processed.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if OK to terminate; kFalse otherwise.

virtual ErrorCode Facade::IWorkgroupFacade::CheckIn	(	UIDRef	assetRef,
		bool16	doSaveChanges,
		const PMString *	versionComment = `nil`,
		UIFlags	uiFlags = `kFullUI`,
		bool16	doSaveVersion = `kTrue`,
		const PMString *	checkedOutToUserName = `nil`,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method saves asset changes to the asset management system as a new version of the asset. Services executed (in order): IAMServiceProvider::enCheckIn, IAMServiceProvider::enAfterCheckIn.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
doSaveChanges	applies to file-based assets. Specifying kTrue writes (saves) unsaved model changes to the local asset replica file. Specify kFalse to skip the save.
versionComment	is a valid pointer to a PMString populated with the version (checkin) comments. This PMString is typically obtained from the UI.
uiFlags	specifies the UI permitted during the method execution.
checkedOutToUserName	specifies the userName that the asset is checked out to. This must be the same user name specified for the IWorkgroupFacade::CheckOut() method.
doSaveVersion	if kTrue, tells the asset management system to save a new version of the asset. Ignored if the asset management system does not support historical versioning.
objectUID	is the UID of the model object (e.g., page item) associated with the asset. The database of the model object must be the same as asset's. The value is converted to a UIDRef and passed to the enCheckOut service as an IAMService::enModelObject.

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

virtual ErrorCode Facade::IWorkgroupFacade::CheckIn	(	const IDFile &	assetFile,
		const PMString *	versionComment = `nil`,
		const IWorkgroupFacade::ForceSave &	forceSave = `IWorkgroupFacade::enForceSaveUnspecified`
	)

pure virtual

This method saves the local contents of a file as a new version. Use this method to save a version when model changes have already been saved to a file. Service executed: IAMServiceProvider::enCheckIn.

Parameters

assetfile	is the IDFile to which the latest changes have been written.
versionComment	is a valid pointer to a PMString populated with the version (checkin) comments. This PMString is typically obtained from the UI.
forceSave	specifies the ForceSave option in the event of a version conflict.

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

virtual ErrorCode Facade::IWorkgroupFacade::CheckIn	(	const IWorkgroupFacade::FileList &	inIDFileList,
		const PMString &	inComment
	)

pure virtual

This method checks in a list of files. Files that are not managed are skipped without generating an error. Service executed: IAMServiceProvider::enBatchCheckIn if available, otherwise IAMServiceProvider::enCheckIn.

Parameters

inIDFileList	contains the list of IDFiles to check in.
inComment	is a valid pointer to a PMString populated with the version (checkin) comments. This PMString is typically obtained from the UI. The same comment is applied to each file that is checked in.

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

virtual ErrorCode Facade::IWorkgroupFacade::CheckIn	(	const UIDList &	inLinkResources,
		UIFlags	uiFlags = `kFullUI`
	)

pure virtual

This method checks in a list of ILinkResources. ILinkResources that are not managed are skipped without generating an error. Service executed: IAMServiceProvider::enBatchCheckIn if available, otherwise IAMServiceProvider::enCheckIn.

Parameters

inLinkResources contains the list of ILinkResource UIDs to check in.

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

virtual ErrorCode Facade::IWorkgroupFacade::CheckOut	(	UIDRef	assetRef,
		UIFlags	uiFlags = `kFullUI`,
		const PMString *	checkOutToUserName = `nil`,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method checks out an asset to a user for editing. Services executed (in order): IAMServiceProvider::enBeforeCheckOut, IAMServiceProvider::enCheckOut.

Parameters

assetRef	is a UIDRef for an IManageableAsset to check out.
uiFlags	specifies the UI permitted during the method execution.
checkOutToUserName	optional parameter to specify who to check out the asset to (default is current user).
objectUID	is the UID of the model object (e.g., page item) associated with the asset. The database of the model object must be the same as asset's. The value is converted to a UIDRef and passed to the enCheckOut service as an IAMService::enModelObject.

Returns: kSuccess if it worked otherwise an error code.

virtual ErrorCode Facade::IWorkgroupFacade::EnsureLatestVersion ( const IDFile & file )

pure virtual

This method ensures that an IDFile represents the latest version of a versioned asset. This method returns kSuccess and has no effect if the file is not a versioned asset. Service executed: IAMServiceProvider::enEnsureLatestVersion.

Parameters

file	is an IDFile with a valid path.

Returns: kSuccess if file is the latest version or is otherwise OK to use as is; returns an ErrorCode if the operation failed (e.g., lost communication with the asset management system).

virtual ErrorCode Facade::IWorkgroupFacade::EnsureLatestVersion ( IDataLink * dl )

pure virtual

DEPRECATED; use alternate method with the same name. This method ensures that the content referenced by an IDataLink is the latest version. This method returns kSuccess and has no effect if the IDataLink is not to a versioned asset. Service executed: IAMServiceProvider::enEnsureLatestVersion.

Parameters

dl	is a valid pointer to an IDataLink instance.

Returns: kSuccess if the method succeeded; otherwise returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::EnsureLatestVersion ( UIDRef assetRef )

pure virtual

This method ensures that the external asset associated with an IManageableAsset is the latest version. Returns kSuccess and has no effect if the IManageableAsset is not versioned. Service executed: IAMServiceProvider::enEnsureLatestVersion.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kSuccess if the method succeeded; otherwise returns a failure ErrorCode.

virtual void Facade::IWorkgroupFacade::GetCurrentUserName	(	UIDRef	assetRef,
		PMString &	outCurrentUserName
	)

pure virtual

This method retrieves the IManagedStatus::enCurrentUser for an IManageableAsset.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
outCurrentUserName	is populated with the IManagedStatus::enCurrentUser.

See Also: IManagedStatus.

virtual IManagedStatus::EditingState Facade::IWorkgroupFacade::GetEditingState ( UIDRef assetRef )

pure virtual

This method retrieves the IManagedStatus::EditingState for an IManageableAsset.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: the IManagedStatus::EditingState.

See Also: IManagedStatus.

virtual IAMLockable::LockState Facade::IWorkgroupFacade::GetLockState	(	UIDRef	assetRef,
		bool16	doVerification = `kFalse`,
		UIFlags	uiFlags = `kFullUI`,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method retrieves the IAMLockable::LockState for an IManageableAsset.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
doVerification	setting this to kTrue will contact the asset management system for the current lock state. If kFalse, retrieves the cached status. Use this flag judiciously: setting to kTrue could, depending on the AMSP, hit the network or result in file I/O.
uiFlags	specifies the UI permitted during the method execution.
objectUID	is the UID of the model object (e.g., page item) associated with the asset.

Returns: the IAMLockable::LockState.

See Also: IAMLockable.

virtual void Facade::IWorkgroupFacade::GetStatusString	(	UIDRef	assetRef,
		int32	wgStatusID,
		PMString &	outStatusStr
	)

pure virtual

This method retrieves a display status string for a IManagedStatus::WGStatusType.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
wgStatusID	is the IManagedStatus::WGStatusType or otherwise unique identifier.
outStatusStr	is populated with the status text if it was found.

See Also: IManagedStatus.

virtual ErrorCode Facade::IWorkgroupFacade::GetUniqueAssetLocation	(	const IDFile &	inProposedFile,
		IDFile &	outUniqueFile
	)

pure virtual

This method obtains a unique managed asset location based on a proposed path. If a file already exists at the proposed path, the filename is munged to obtain a new path.

Parameters

inProposedFile	the suggested unique path.
outUniqueFile	the unique valid path that is guaranteed to not already exist. This may be the same as inProposedFile.

Returns: kSuccess if outUniqueFile is set to the unique path; otherwise it returns failure ErrorCode.

virtual UIFlags Facade::IWorkgroupFacade::GetUserInteractionLevel ( )

pure virtual

This method retrieves the currently stored user interaction level.

Returns: UIFlags for permissible UI.

virtual IManagedStatus::VersionState Facade::IWorkgroupFacade::GetVersionState ( UIDRef assetRef )

pure virtual

This method retrieves the IManagedStatus::VersionState for an IManageableAsset.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: the IManagedStatus::VersionState.

See Also: IManagedStatus.

virtual bool16 Facade::IWorkgroupFacade::HasVersionedContent ( UIDRef assetRef )

pure virtual

This method tests if an IManageableAsset is associated with versioned content either directly or via a link. For AssetType::enDocument, this method is identical to IWorkgroupFacade::IsVersioned (defined below).

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if the asset is versioned; kFalse otherwise.

virtual ErrorCode Facade::IWorkgroupFacade::InitDocumentAssetManagement	(	UIDRef	assetRef,
		const IDFile &	file = `IDFile()`
	)

pure virtual

This method prepares an IManageableAsset for servicing and monitoring as a document (IManageableAsset:: enDocument) by calling the IAMSPManager::BindAsset() method and an initializer service if available. This method may be called for the same assetRef any number of times. Each time it is called, any previous IManagedStatus data is discarded. Service executed: IAMServiceProvider::enInitialize. If you call this method for an IManageableAsset, you must also call the IWorkgroupFacade::TerminateAssetManagement() method.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
file	specified an IDFile with a valid absolute path.

Returns: kSuccess if the initialization completed without error; otherwise, it returns a failure ErrorCode.

See Also: TerminateAssetManagement.

virtual ErrorCode Facade::IWorkgroupFacade::InitLinkAssetManagement	(	UIDRef	assetRef,
		bool16	useStoredAssetManagementData = `kFalse`
	)

pure virtual

This method prepares an IManagableAsset for servicing and monitoring as a link (IManageableAsset::enLinked) by calling the IAMSPManager::BindAsset() method and an initializer service if available. This method may be called for the same assetRef any number of times. Each time it is called, any previous IManagedStatus data is discarded. Service executed: IAMServiceProvider::enInitialize. If you call this method for an IManageableAsset, you must also call the IWorkgroupFacade::TerminateAssetManagement() method.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
useStoredAssetManagementData	if kTrue, the IManageableAsset will be initialized from stored (persistent) asset reference data, if available. If kFalse, clears any peristent asset reference data and initializes from the ILink location.

Returns: kSuccess if the initialization completed without error; otherwise, it returns a failure ErrorCode.

See Also: TerminateAssetManagement.

virtual ErrorCode Facade::IWorkgroupFacade::InitWithoutAssetManagement ( UIDRef assetRef )

pure virtual

This method initializes an IManageableAsset without asset management capability. This is useful when a boss has an IManageableAsset interface, but is not otherwise associated with a managed asset. For example, a standalone InCopy kDocBoss is initialized without asset management, since the kDocBoss is an internal container not associated with an external ID document file.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kSuccess if the initialization completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::InvalidateProxyVersionNumber ( IDataLink * dl )

pure virtual

DEPRECATED; use alternate method with the same name. This method invalidates the proxy version number associated with an IDataLink so that the link state is reported as IDataLink::kLinkOutOfDate (via IWorkgroupFacade::OverrideLinkState). The proxy version number is the version number of the asset that the proxy (InDesign document model object) was created from. This method should be called for an IDataLink when it is pointed to a different asset. Service executed: IAMServiceProvider::enInvalidateProxyVersionNumber.

Parameters

dl	is a valid pointer to an IDataLink instance.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::InvalidateProxyVersionNumber ( UIDRef assetRef )

pure virtual

This method invalidates the proxy version number associated with an ILink. The proxy version number is the version number of the asset that the proxy (InDesign document model object) was created from. This method should be called for an ILink when it is pointed to a different asset. Service executed: IAMServiceProvider::enInvalidateProxyVersionNumber.

Parameters

assetRef is a UIDRef for an IManageableAsset of type IManageableAsset::enLinked.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual bool16 Facade::IWorkgroupFacade::IsAssetManagementInitialized ( UIDRef assetRef )

pure virtual

This method tests if an IManageableAsset has been initialized via one of the asset management initialization methods.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if initialized; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::IsCheckedOut	(	UIDRef	assetRef,
		UID	objectUID = `kInvalidUID`
	)

pure virtual

This method tests if an asset is checked out.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
objectUID	is the UID of the model object associated with the lock.

Returns: kTrue if checked out; kFalse if not.

See Also: IAMLockable.

virtual bool16 Facade::IWorkgroupFacade::IsLatestVersion ( UIDRef assetRef )

pure virtual

This method tests if a newer version of an asset exists in the asset management system.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if a newer version is available; kFalse if the IManageableAsset represents the current version.

virtual bool16 Facade::IWorkgroupFacade::IsLockable ( UIDRef assetRef )

pure virtual

This method tests if an IManageableAsset can be locked (it must have an IAMLockable instance).

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if the asset can be locked; kFalse if not.

virtual bool16 Facade::IWorkgroupFacade::IsMonitoring ( UIDRef assetRef )

pure virtual

This method tests if an asset is currently being monitored for IManagedStatus changes.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if an IAssetMonitor instance is currently monitoring the asset; kFalse otherwise.

See Also: IWorkgroupFacade::StartMonitoring; IWorkgroupFacade::StopMonitoring; IAssetMonitor; IManagedStatus

virtual bool16 Facade::IWorkgroupFacade::IsNewerVersionAvailable ( UIDRef assetRef )

pure virtual

This method tests if a newer version of a versioned asset is available. This method is similar to IsLatestVersion(), except that it verifies that the asset management system is online for the purpose of downloading the latest version.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if a newer version can be downloaded; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::IsOnline ( UIDRef assetRef )

pure virtual

This method tests if a server-based asset is accessible.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if online or asset is not managed; kFalse if no server connection.

virtual bool16 Facade::IWorkgroupFacade::IsTemporaryVersion ( const IDFile & file )

pure virtual

This method test if a file is a temporary file created from an older version of an asset. A temporary file is opened strictly for viewing (read-only).

Parameters

file	is an IDFile with a path to an existing file.

Returns: kTrue if file is a temporary version; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::IsVersioned ( UIDRef assetRef )

pure virtual

This method tests if an IManageableAsset is versioned. For IManageableAsset AssetType::enLinked, this method will always return kFalse, regardless of whether or not the link is to a versioned asset (use the IWorkgroupFacade:: HasVersionedContent() method instead).

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if versioned and AssetType::enDocument; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::IsVersioned ( const IDFile & file )

pure virtual

This method tests if a file represents a versioned asset.

Parameters

file	is an IDFile with a path to an existing file.

Returns: kTrue if file is a versioned asset; kFalse otherwise.

virtual bool16 Facade::IWorkgroupFacade::IsWriteable ( UIDRef assetRef )

pure virtual

This method tests if an IManageableAsset can be written. By default, assets of type AssetType::enDocument can written, but enLinked assets, with the exception of stories, can not.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kTrue if writeable; kFalse if not.

virtual IDataLink::StateType Facade::IWorkgroupFacade::OverrideLinkState	(	UIDRef	assetRef,
		IDataLink::StateType	localState
	)

pure virtual

DEPRECATED; no longer functional. This method overrides the IDataLink state with the corrected state based on the asset management state information. For example, the IDataLink::StateType may be kLinkMissing because the cached asset file is missing, when in fact the correct state may be kLinkNormal and the asset file simply needs to be downloaded from the asset management system.

Parameters

assetRef	is a UIDRef for an AssetType::enLinked IManageableAsset.
localState	is the IDataLink state with respect to the local linked file.

Returns: the corrected IDataLink::StateType (may be the same as localState).

virtual IOpenFileCmdData::OpenFlags Facade::IWorkgroupFacade::OverrideOpenFlags	(	const IDFile &	file,
		IOpenFileCmdData::OpenFlags	inOpenFlags
	)

pure virtual

This method overrides the open flags that are used to control how a document file is opened. The underlying AMSP implementation is responsible for assuring that the open flags will open a managed document file in the right way. For example, a temporary version indd file supplied by Version Cue must be opened as a new, unsaved file, rather than as a normal document file.

Parameters

file	is an IDFile with a path to an existing file.
inOpenFlags	are the presumed IOpenFileCmdData::OpenFlags.

Returns: the corrected IOpenFileCmdData::OpenFlags.

virtual ErrorCode Facade::IWorkgroupFacade::RemoveStatusListener	(	UIDRef	listenerRef,
		UIDRef	assetRef
	)

pure virtual

This method removes a status listener from an asset's managed status boss.

Parameters

listenerRef	is the UIDRef of an IAMStatusListener.
assetRef	is a UIDRef for an IManageableAsset.

Returns: ErrorCode if there was an error; otherwise returns kSuccess.

See Also: IAMStatusListener.

virtual void Facade::IWorkgroupFacade::RestoreUserInteractionLevel ( )

pure virtual

This method restores the previously saved user interaction level.

virtual bool16 Facade::IWorkgroupFacade::RetrieveCheckInComment	(	const IDFile &	file,
		PMString &	outComment
	)

pure virtual

This method retrieves a stored checkin comment. After this method returns, the comment is no longer in the store.

Parameters

file	is an IDFile with a path to an existing file.
outComment	is populated with the text of the comment.

Returns: kTrue if a comment was available (outComment may be empty if comment was blank); kFalse if not available.

See Also: IWorkgroupFacade::StoreCheckInComment.

virtual ForceSave Facade::IWorkgroupFacade::RetrieveForceSaveOption ( const IDFile & file )

pure virtual

This method retrieves the force save option. The option is no longer in the store after this call.

Parameters

file	is an IDFile with a path to an existing file.

Returns: IWorkgroupFacade::ForceSave option.

virtual ErrorCode Facade::IWorkgroupFacade::Revert ( UIDRef assetRef )

pure virtual

This method reverts a modified local asset by replacing it with the current version of the asset. Service executed: IAMServiceProvider::enRevert.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::StartMonitoring ( UIDRef assetRef )

pure virtual

This method starts monitoring an IManageableAsset for status changes. The IManageableAsset must be initialized via IWorkgroupFacade::InitDocumentAssetManagement() or InitLinkAssetManagement() before calling this method. This method has no affect if the asset is already being monitored.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

See Also: IWorkgroupFacade::StopMonitoring

virtual ErrorCode Facade::IWorkgroupFacade::StopMonitoring ( UIDRef assetRef )

pure virtual

This method stops monitoring an IManageableAsset for status changes. This method has no affect if StartMonitoring() was not called beforehand. Once monitoring has stopped, it may be resumed by calling StartMonitoring().

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

See Also: IWorkgroupFacade::StartMonitoring

virtual void Facade::IWorkgroupFacade::StoreCheckInComment	(	const PMString &	inComment,
		const IDFile &	file
	)

pure virtual

This method stores a checkin comment for later retrieval. The comment remains in the store until it is retrieved.

Parameters

inComment	is a PMString with the comment; an empty string denotes a valid blank comment.
file	is an IDFile with a path to an existing file. This is the file that will be checked in.

See Also: IWorkgroupFacade::RetrieveCheckInComment.

virtual void Facade::IWorkgroupFacade::StoreForceSaveOption	(	const IDFile &	file,
		const ForceSave &	forceSave
	)

pure virtual

This method stores the force save option for later retrieval. The option remains in the store until it is retrieved.

Parameters

file	is an IDFile with a path to an existing file.
forceSave	is the ForceSave option to store with the file.

virtual void Facade::IWorkgroupFacade::StoreUserInteractionLevel ( const UIFlags & uiFlags )

pure virtual

This method stores the user interaction level for later retrieval. The previously stored interaction level is saved and can be restored using IWorkgroupFacade::RestoreUserInteractionLevel().

Parameters

uiFlags the new user interaction level.

virtual ErrorCode Facade::IWorkgroupFacade::TerminateAssetManagement ( UIDRef assetRef )

pure virtual

This method terminates asset management capability associated with an IManageableAsset. Service executed: IAMServiceProvider::enTerminate.

Parameters

assetRef is a UIDRef for an IManageableAsset.

Returns: kSuccess if the termination succeeded; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateLinkLocation ( IDataLink * dl )

pure virtual

DEPRECATED; use alternate method with the same name. This method executes an IAMServiceProvider::enUpdateLinkLocation service for an IDataLink instance.

Parameters

dl	is a valid pointer to an IDataLink instance.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateLinkLocation ( UIDRef assetRef )

pure virtual

This method executes an IAMServiceProvider::enUpdateLinkLocation service for an ILink instance.

Parameters

assetRef is a UIDRef for an IManageableAsset of type IManageableAsset::enLinked.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateProxyVersionNumber ( IDataLink * dl )

pure virtual

DEPRECATED; use alternate method with the same name. This method updates the proxy version number associated with an IDataLink. This method should be called for an IDataLink whenever the proxy is created from the asset. This method returns kSuccess and has no affect unless the link is to a versioned asset. Service executed: IAMServiceProvider::enUpdateProxyVersionNumber.

Parameters

dl	is a valid pointer to an IDataLink instance.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateProxyVersionNumber ( UIDRef assetRef )

pure virtual

This method updates the proxy version number associated with an ILink. This method should be called for an ILink whenever the proxy is created from the asset. This method returns kSuccess and has no affect if the ILink is not for a versioned asset. Service executed: IAMServiceProvider::enUpdateProxyVersionNumber.

Parameters

assetRef is a UIDRef for an IManageableAsset of type IManageableAsset::enLinked.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateScriptedAssetData	(	UIDRef	assetRef,
		const PMString &	scriptString,
		int32	scriptID
	)

pure virtual

This method calls the IAMServiceProvider::UpdateScriptedAssetData method for an IManageableAsset.

Parameters

assetRef	is a UIDRef for an IManageableAsset.
scriptString	is the IScriptRequestData converted to a PMString.
scriptID	is the script data item's ScriptID.

See Also: IAMServiceProvider::UpdateScriptedAssetData.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateStoredAssetReference ( IDataLink * dl )

pure virtual

DEPRECATED; use alternate method with the same name. This method uses IAMServiceProvider::enUpdateStoredAssetReference service to update AMSP-specific asset reference data that is persisted (stored) with a linked asset.

Parameters

dl	is a valid pointer to an IDataLink instance.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

virtual ErrorCode Facade::IWorkgroupFacade::UpdateStoredAssetReference ( UIDRef assetRef )

pure virtual

This method uses IAMServiceProvider::enUpdateStoredAssetReference service to update AMSP-specific asset reference data that is persisted (stored) with a linked asset.

Parameters

assetRef is a UIDRef for an IManageableAsset of type IManageableAsset::enLinked.

Returns: kSuccess if the method completed without error; otherwise, it returns a failure ErrorCode.

Enumerator
enForceSaveYes	OK to checkin even though a newer version exists
enForceSaveNo	Do not checkin if a newer version exists
enForceSaveUnspecified	Undecided; display UI for user assistance

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation