CusDtLnkImportLinkConverter Class Reference

Inheritance diagram for CusDtLnkImportLinkConverter:

Public Types
typedef CPMUnknown< ILink >	inherited

Public Member Functions
	CusDtLnkImportLinkConverter (IPMUnknown *boss)
virtual LinkType	GetLinkType () const
virtual LinkClientID	GetClientID () const
virtual UID	GetResource () const
virtual void	SetResource (UID resourceUID)
virtual ResourceModificationState	GetResourceModificationState () const
virtual void	SetResourceModificationState (ResourceModificationState modState)
virtual UID	GetObject () const
virtual void	SetObject (UID objectUID)
virtual ObjectModificationState	GetObjectModificationState () const
virtual void	SetObjectModificationState (ObjectModificationState modState)
virtual bool16	GetShowInUI () const
virtual void	SetShowInUI (bool16 bShowInUI)
virtual bool16	GetCanEmbed () const
virtual void	SetCanEmbed (bool16 bCanEmbed)
virtual bool16	GetCanUnembed () const
virtual void	SetCanUnembed (bool16 bCanUnembed)
virtual bool16	GetCanPackage () const
virtual void	SetCanPackage (bool16 bCanPackage)
virtual ImportPolicy	GetImportPolicy () const
virtual void	SetImportPolicy (ImportPolicy policy)
virtual WideString	GetImportStamp () const
virtual IDTime	GetImportModTime () const
virtual IDTime	GetLastImportTime () const
virtual ExportPolicy	GetExportPolicy () const
virtual void	SetExportPolicy (ExportPolicy policy)
virtual IDTime	GetLastExportTime () const
virtual void	AddChildren (const UIDList &children)
virtual void	DeleteChildren (const UIDList &children)
virtual uint32	GetChildren (UIDList &children) const
virtual uint32	GetNumChildren () const
virtual UID	GetParent () const
virtual ErrorCode	Update (bool bForceUpdate, UIFlags uiFlags, UID &linkUID)
virtual ErrorCode	CopyAttributes (const UIDRef &linkRef)
virtual ErrorCode	Init (IDataLink *iDataLink)
Public Member Functions inherited from CPMUnknown< ILink >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete
Public Member Functions inherited from ILink
virtual ErrorCode	Update (bool bForceUpdate, UIFlags uiFlags, UID &linkUID)=0

Additional Inherited Members
Protected Member Functions inherited from CPMUnknown< ILink >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< ILink >
HelperInterface	fHelperInterface

Member Function Documentation

virtual void CusDtLnkImportLinkConverter::AddChildren ( const UIDList &  children )

inlinevirtual

Adds child links to the link's hierarchy.

Parameters

children

[IN] UIDs of the child links to add to the link's hierarchy.

Returns

kSuccess if the child links were successfully added, else an error code.

Implements ILink.

virtual ErrorCode CusDtLnkImportLinkConverter::CopyAttributes ( const UIDRef &  linkRef )

inlinevirtual

Copies the attributes of the link referenced by the given UIDRef to this link.

Parameters

linkRef

[IN] UIDRef of the link to copy. \ The UIDRef may reference a link in a different database.

Returns

kSuccess if the link attributes were successfuly copied, else an error code.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::DeleteChildren ( const UIDList &  children )

inlinevirtual

Deletes child links from the link's hierarchy.

Parameters

children

[IN] UIDs of the child links to deleted from the link's hierarchy.

Returns

kSuccess if the child links were successfully deleted, else an error code.

Implements ILink.

virtual bool16 CusDtLnkImportLinkConverter::GetCanEmbed ( ) const

inlinevirtual

Returns whether the link allows the resource to be embedded.

Returns

True if the link allows the resource to be embedded, else false.

Implements ILink.

virtual bool16 CusDtLnkImportLinkConverter::GetCanPackage ( ) const

inlinevirtual

Returns whether the link allows the resource to be packaged.

Returns

True if the link allows the resource to be packaged, else false.

Implements ILink.

virtual bool16 CusDtLnkImportLinkConverter::GetCanUnembed ( ) const

inlinevirtual

Returns whether the link allows the resource to be unembedded.

Returns

True if the link allows the resource to be unembedded, else false.

Implements ILink.

virtual uint32 CusDtLnkImportLinkConverter::GetChildren ( UIDList &  children ) const

inlinevirtual

Gets direct descendant child links from the link's hierarchy.

Parameters

children

[OUT] UIDs of the child links in the link's hierarchy.

Returns

Number of direct descendant child links in the link's hierarchy that were retrieved.

Implements ILink.

virtual LinkClientID CusDtLnkImportLinkConverter::GetClientID ( ) const

inlinevirtual

Returns the link's link client identifier.

Returns

Link's link client identifier.

Implements ILink.

virtual ExportPolicy CusDtLnkImportLinkConverter::GetExportPolicy ( ) const

inlinevirtual

Returns the policy specifying when to update the link resource via an export when the object is marked modified. \ The export policy is always kNoAutoExport for an import link.

Returns

Link's update export policy.

Implements ILink.

virtual IDTime CusDtLnkImportLinkConverter::GetImportModTime ( ) const

inlinevirtual

Returns the resource's modification date/time when it was last imported.

Returns

Resource's modification date/time when it was last imported. \ 0 if the link type is kExport, the resource has never been imported.

Implements ILink.

virtual ImportPolicy CusDtLnkImportLinkConverter::GetImportPolicy ( ) const

inlinevirtual

Returns the policy specifying when to update the link object via an import when the resource is marked modified. \ The import policy is always kNoAutoImport for an export link.

Returns

Link's update export policy.

Implements ILink.

virtual WideString CusDtLnkImportLinkConverter::GetImportStamp ( ) const

inlinevirtual

Returns the resource's stamp when it was last imported.

Returns

Resource's stamp when it was last imported. \ Undefined if the link type is kExport, or the resource has never been imported.

Implements ILink.

virtual IDTime CusDtLnkImportLinkConverter::GetLastExportTime ( ) const

inlinevirtual

Returns the date and time that the object was last exported to the resource.

Returns

Date and time that the object was last exported to the resource. \ 0 if the link type is kImport, or the object has never been exported.

Implements ILink.

virtual IDTime CusDtLnkImportLinkConverter::GetLastImportTime ( ) const

inlinevirtual

Returns the date and time the resource was the last imported into the object.

Returns

Date and time the resource was the last imported into the object. \ 0 if the link type is kExport, or the resource has never been imported.

Implements ILink.

virtual LinkType CusDtLnkImportLinkConverter::GetLinkType ( ) const

inlinevirtual

Returns the type of the link.

Returns

Type of the link.

Implements ILink.

virtual uint32 CusDtLnkImportLinkConverter::GetNumChildren ( ) const

inlinevirtual

Returns the number of direct descendant child links in the link's hierarchy.

Returns

Number of direct descendant child links in the link's hierarchy.

Implements ILink.

virtual UID CusDtLnkImportLinkConverter::GetObject ( ) const

inlinevirtual

Returns the UID of the link object associated with the link.

Returns

UID of the linked object. \ kInvalidUID if the link object UID has not been set.

Implements ILink.

virtual ObjectModificationState CusDtLnkImportLinkConverter::GetObjectModificationState ( ) const

inlinevirtual

Returns the linked object's modification state. \ The object modification state is always kObjectUnmodified for import links.

Returns

Linked object's modification state.

Implements ILink.

virtual UID CusDtLnkImportLinkConverter::GetParent ( ) const

inlinevirtual

Gets links that are direct parents the link.

Returns

UID of the link's parent link, else kInvalidUID.

Implements ILink.

virtual UID CusDtLnkImportLinkConverter::GetResource ( ) const

inlinevirtual

Returns the UID of the resource associated with the link.

Returns

UID of the linked resource. \ kInvalidUID if the resource UID has not been set.

Implements ILink.

virtual ResourceModificationState CusDtLnkImportLinkConverter::GetResourceModificationState ( ) const

inlinevirtual

Returns the linked resource's modification state. The resource modification state is always kResourceUnmodified for export links.

Returns

Linked resource's modification state.

Implements ILink.

virtual bool16 CusDtLnkImportLinkConverter::GetShowInUI ( ) const

inlinevirtual

Returns whether the link should be displayed in the Links UI.

Returns

True if the link should be displayed in the Links UI, else false.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetCanEmbed ( bool16  bCanEmbed )

inlinevirtual

Sets whether the link allows the resource to be embedded.

Parameters

bCanEmbed

[IN] Boolean denoting whether the link's resource can be embedded.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetCanPackage ( bool16  bCanPackage )

inlinevirtual

Sets whether the link allows the resource to be packaged.

Parameters

bCanPackage

[IN] Boolean denoting whether the link's resource can be packaged.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetCanUnembed ( bool16  bCanUnembed )

inlinevirtual

Sets whether the link allows the resource to be unembedded.

Parameters

bCanUnembed

[IN] Boolean denoting whether the link's resource can be unembedded.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetExportPolicy ( ExportPolicy  policy )

inlinevirtual

Sets the policy specifying when to update the link resource via an export when the object is marked modified. \ The update export policy is ignored for import links.

Parameters

policy

[IN] Link's update export policy.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetImportPolicy ( ImportPolicy  policy )

inlinevirtual

Sets the policy specifying when to update the link object via an import when the resource is marked modified. \ The update import policy is ignored for export links.

Parameters

policy

[IN] Link's update import policy.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetObject ( UID  objectUID )

inlinevirtual

Sets the UID of the link object associated with the link.

Parameters

objectUID

[IN] UID of the linked object.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetObjectModificationState ( ObjectModificationState  modState )

inlinevirtual

Sets the linked object's modification state. \ The object modification state is ignored for import links.

Parameters

modState

[IN] Modification state of the linked object.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetResource ( UID  resourceUID )

inlinevirtual

Sets the UID of the link resource associated with the link.

Parameters

resourceUID

[IN] UID of the linked resource.

Implements ILink.

void CusDtLnkImportLinkConverter::SetResourceModificationState ( ResourceModificationState  modState )

virtual

Sets the linked resource's modification state. The resource modification state is ignored for export links.

Parameters

modState

[IN] Modification state of the linked resource.

Implements ILink.

virtual void CusDtLnkImportLinkConverter::SetShowInUI ( bool16  bShowInUI )

inlinevirtual

Sets whether the link should be displayed in the Links UI.

Parameters

bShowInUI

[IN] Boolean denoting whether the link should be displayed in the Links UI.

Implements ILink.