All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDAAttachDocument

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---CATIAVPMVDAAttachDocument
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIAVPMVDAAttachDocument

Interface to attach a document to a Business Object.
Role: This interface is implemented by Business Objects. A document can be attached by different ways to different kinds of Business Objects. This interface defines the server command to do so.


Method Index


o get_DocRole(CATUnicodeString&)
Retrieves the type of the Document Role between the Business Object and its attached document.
o get_Document(CATIAVPMDocumentVersion*&)
Retrieves the document to attach to the Business Object.
o get_Father(ENOVIABusinessObject*&)
Retrieves the Business Object to which the document is to be attached.
o get_Link(CATUnicodeString&)
Retrieves the type of the link between the Business Object and its attached document.
o get_Location(boolean&)
Retrieves whether the document is attached to the instance or to the reference.
o put_DocRole(CATUnicodeString&)
Sets the type of the Role between the Business Object and the document.
o put_Document(CATIAVPMDocumentVersion*)
Sets the document to attach to the Business Object.
o put_Father(ENOVIABusinessObject*)
Sets the Business Object to which the document is to be attached.
o put_Link(CATUnicodeString&)
Sets the type of the link between the Business Object and the document.
o put_Location(boolean)
Sets whether the document should be attached to the instance or to the reference of the Business Object.

Methods


o get_DocRole
public virtual HRESULT get_DocRole(CATUnicodeString& oDocRole)= 0
Retrieves the type of the Document Role between the Business Object and its attached document.
Parameters:
oDocRole
The type of the Document Role
Returns:
Always S_OK.
o get_Document
public virtual HRESULT get_Document(CATIAVPMDocumentVersion*& oDocument)= 0
Retrieves the document to attach to the Business Object.
Role: This method is designed for user exit purposes and should not be used in another context.
Parameters:
oDocument
The document to attach
Returns:
Always S_OK.
o get_Father
public virtual HRESULT get_Father(ENOVIABusinessObject*& oParent)= 0
Retrieves the Business Object to which the document is to be attached. This Business Object is the parent of the document.
Role: This method is designed for user exit purposes and should not be used in another context.
Parameters:
oParent
The parent Business Object
Returns:
Always S_OK
o get_Link
public virtual HRESULT get_Link(CATUnicodeString& oLinkType)= 0
Retrieves the type of the link between the Business Object and its attached document.
Parameters:
oLinkType
The type of the link
Returns:
Always S_OK.
o get_Location
public virtual HRESULT get_Location(boolean& oOnInstance)= 0
Retrieves whether the document is attached to the instance or to the reference.
Parameters:
oOnInstance
Legal values: True if the document is attached to the instance. False if the document is attached to the reference.
Returns:
Always S_OK.
o put_DocRole
public virtual HRESULT put_DocRole(CATUnicodeString& iDocRole)= 0
Sets the type of the Role between the Business Object and the document.
Parameters:
iDocRole
The type of the Document Role
Legal values:
""
"" indicates that the document is not considered to be part of the definition of the object to which you are attaching/detaching, but is still subject to the rule that you cannot attach/detach if the object is in a non-updatable lifecycle state. (Optional/Various meanings)
Primary
Primary indicates that the doc is considered an integral part of the definition of the object to which you are attaching/detaching. If the object is in a non-updatable lifecycle state, then you can't attach/detach the doc. An example would be the geometry doc attached to a part.
Secondary
Secondary indicates that the doc is not critical to the definition of the object to which you are attaching/detaching. If the object is in a non-updatable lifecycle status, then you can still detach/attach a secondary doc. An example of this is a quality analysis of this part from various vendors.
Returns:
Always S_OK.
o put_Document
public virtual HRESULT put_Document(CATIAVPMDocumentVersion* iDocument)= 0
Sets the document to attach to the Business Object.
Parameters:
iDocument
The document to attach
Returns:
Legal values:
S_OK
Success - The document to attach to the Business Object is correctly set
E_FAIL
Failure - The document to attach to the Business Object cannot be set because ...
o put_Father
public virtual HRESULT put_Father(ENOVIABusinessObject* iParent)= 0
Sets the Business Object to which the document is to be attached. This Business Object is the parent of the document.
Parameters:
iParent
The parent Business Object
Returns:
Legal values:
S_OK
Success - The Business Object to which the document is to be attached is correctly set
E_FAIL
Failure - The Business Object to which the document is to be attached cannot be set because ...
o put_Link
public virtual HRESULT put_Link(CATUnicodeString& iLinkType)= 0
Sets the type of the link between the Business Object and the document.
Parameters:
iLinkType
The type of the link
Legal values:
VPMTPDocumentation
Specifies a documentation link type.
VPMTPRepresentation
Specifies a representation link type.
Returns:
Always S_OK.
o put_Location
public virtual HRESULT put_Location(boolean iOnInstance)= 0
Sets whether the document should be attached to the instance or to the reference of the Business Object.
Parameters:
iOnInstance
Legal values: True to attach the document to the instance. False to attach the document to the reference.
Returns:
Always S_OK.

This object is included in the file: CATIAVPMVDAAttachDocument.h
If needed, your Imakefile.mk should include the module: VDO0Commands

Copyright © 2003, Dassault Systèmes. All rights reserved.