All Frameworks  Class Hierarchy  This Framework  Indexes   

CATInstantCollabDesignCAAItf Interface CATIColId

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


interface CATIColId

CATIColId manage the identification of a collaboration object


Method Index


o GetColObject(CATBaseUnknown**)
Retreive the object (real or collab deletion) corresponding to an Id
o GetColRealObject(CATBaseUnknown**)
Retreive the real object corresponding to an Id
o GetLocalInfo(CATCollabLocalInfo&)
Valuates a CATCollabLocalInfo containing the timestamp, briefcase ids and all the
necessary information to know the status of the object in the current document
  • Last modification by current user from current document
  • Last shared by current user from current document and the associated briefcase Id
  • Last merged by current user in current document and the associated briefcase Id
  • o GetWorkspaceInfo(CATCollabWsInfo&)
    Valuates a CATCollabWsInfo containing the timestamp, briefcase ids and all the
    necessary information to know the status of the object in the ACTIVE WORKSPACE
  • Last timestamp of the object in the workspace
  • Last briefcase containing this object
  • Last user who has "pushed" the object in the workspace
  • o SetLocalInfo(CATCollabLocalInfo&)
    Set the CATCollabLocalInfo.
    o SetWorkspaceInfo(CATCollabWsInfo&)
    Set the CATCollabWsInfo.
    o Stream(void*&,int&)
    Write CATIColId into memory
    o ToString(CATUnicodeString&)
    Convert the Collaboration ID to a CATUnicodeString
    Format : each octet value (from 0 to 255) is separated by a "_"

    Methods


    o GetColObject
    public virtual GetColObject( opCollabObj)
    Retreive the object (real or collab deletion) corresponding to an Id
    Parameters:
    opCollabObj
    [out, CATBaseUnknown#Release] Pointer o the retreived object
    Returns:
    Error code of function.
    o GetColRealObject
    public virtual GetColRealObject( opCollabObj)
    Retreive the real object corresponding to an Id
    Parameters:
    opCollabObj
    Pointer o the retreived object
    Returns:
    Error code of function.
    o GetLocalInfo
    public virtual GetLocalInfo( oInfo)
    Valuates a CATCollabLocalInfo containing the timestamp, briefcase ids and all the
    necessary information to know the status of the object in the current document
  • Last modification by current user from current document
  • Last shared by current user from current document and the associated briefcase Id
  • Last merged by current user in current document and the associated briefcase Id
  • Parameters:
    oInfo
    the object to be valuated
    Returns:
    E_FAIL if internal error S_OK otherwise
    o GetWorkspaceInfo
    public virtual GetWorkspaceInfo( oInfo)
    Valuates a CATCollabWsInfo containing the timestamp, briefcase ids and all the
    necessary information to know the status of the object in the ACTIVE WORKSPACE
  • Last timestamp of the object in the workspace
  • Last briefcase containing this object
  • Last user who has "pushed" the object in the workspace
  • Parameters:
    oInfo
    the object to be valuated
    Returns:
    E_FAIL if internal error S_OK otherwise
    o SetLocalInfo
    public virtual SetLocalInfo( const iInfo)
    Set the CATCollabLocalInfo.
    The client application has to modify these attributes after analizing the impact of an operation
    on this object.
    Parameters:
    oInfo
    : the input object containing the information
    Returns:
    : E_FAIL if internal error S_OK otherwise
    o SetWorkspaceInfo
    public virtual SetWorkspaceInfo( const iInfo)
    Set the CATCollabWsInfo.
    The client application has to modify these attributes after receiving the messaging notification which
    contains the information coming from the workspace.
    Parameters:
    oInfo
    the input object containing the information
    Returns:
    E_FAIL if internal error S_OK otherwise
    o Stream
    public virtual Stream( oBuffer,
    oNbBytes)
    Write CATIColId into memory
    Parameters:
    oBuffer
    Memory
    oNbBytes
    number of bytes written in memory
    o ToString
    public virtual ToString( oString)
    Convert the Collaboration ID to a CATUnicodeString
    Format : each octet value (from 0 to 255) is separated by a "_"
    Returns:
    E_FAIL if internal error or if collaboration id is corrupted

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

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