All Frameworks Class Hierarchy This Framework Indexes
CATInstantCollabDesignCAAItf Interface CATIColMergeItem
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIColMergeItem
This interface represents the objects manipulated by the merge engine.
The merge item
encapsulates the feature to merge and some applicative data usefull for collaboration : collaboration id
display name, late type, merge action
Method Index
- o
GetDisplayName(CATUnicodeString&)
- Give the display name of the pointed feature
- o
GetId(CATIColId**,CATBoolean)
- Give the collaboration id of the pointed feature
If bGetRealId==TRUE => this method first try to return the collaboration id of the "real" feature
if it has been located.
- o
GetInitialPath(CATUnicodeString&)
- Give the source path of the pointed feature
- o
GetLateType(CATUnicodeString&)
- Give the late type of the pointed feature
- o
GetMergeFlag(MergeFlag&)
- Get the merge flag : NO_MERGE, MERGE, MERGE_IF_NEEDED, MERGED
- o
GetMergeableContextTable(CATIColMergeContextTable*&)
- Give the CATIColMergeContextTable associated with the pointed CATIColMergeable
- o
GetMergeable(CATBaseUnknown*&)
- Get the underlying feature
- o
GetReferenceBriefcase(CATIColMergeBriefcase**)
- Get the briefcase owning the merge item
- o
GetShareMode(CATIColSharable::ShareMode&)
- Get the share mode defined during the share step.
- o
GetVisibility(CATBoolean&)
- Get the visibility of the feature inside the collaborative application
- o
HaveBeenLocated(CATBoolean&)
- Is there a version of the feature hold by the merge item inside the destination document ?
- o
HaveBeenModified(CATBoolean&)
- If the feature has been retrieved, this methods says if there is a difference between the version
inside the briefcase and the version inside the destination document
- o
HaveBeenShared(CATBoolean&)
- Has the feature been explicitly put inside the briefcase ?
- o
SetMergeFlag(MergeFlag)
- Set the merge flag :
Enumerated Type Index
- o
MergeFlag
- Defines the action which can be set to a merge item
- NO_MERGE : if the feature exists in the destination part, it won't be replaced
- MERGE : replace if exist, create if not
- MERGE_IF_NEEDED : not used
- CREATE : same than merge
- MERGE : the merge item has been processed
Methods
o GetDisplayName
| public virtual GetDisplayName( | | oName) |
-
Give the display name of the pointed feature
- Parameters:
-
- oName
- display name
- Returns:
- S_OK
E_FAIL
o GetId
| public virtual GetId( | | oUuid, |
| | bGetRealId | =TRUE) |
-
Give the collaboration id of the pointed feature
If bGetRealId==TRUE => this method first try to return the collaboration id of the "real" feature
if it has been located. If it has not been located, the method gives the collaboration id of the source feature as
it was in the source document.
If bGetRealId==FALSE => this method returns the collaboration id of the source feature as
it was in the source document.
- Parameters:
-
- oUuid
- [out, CATBaseUnknown#Release] The parameter role...
- bGetRealId
- [inout] The parameter role...
- Returns:
-
S_OK if everything ran ok, otherwise...
E_FAIL
o GetInitialPath
| public virtual GetInitialPath( | | oName) |
-
Give the source path of the pointed feature
- Parameters:
-
- oName
- display name
- Returns:
- S_OK
E_FAIL
o GetLateType
| public virtual GetLateType( | | oLateType) |
-
Give the late type of the pointed feature
- Parameters:
-
- oLateType
- late type
- Returns:
- S_OK
E_FAIL
o GetMergeFlag
| public virtual GetMergeFlag( | | oMergeFlag) |
-
Get the merge flag : NO_MERGE, MERGE, MERGE_IF_NEEDED, MERGED
- Parameters:
-
- oMergeFlag
- merge flag value
- Returns:
- S_OK
E_FAIL
o GetMergeableContextTable
| public virtual GetMergeableContextTable( | | oColContextTable) |
-
Give the CATIColMergeContextTable associated with the pointed CATIColMergeable
- Parameters:
-
- oColContextTable
- an addRef is done
- Returns:
- S_OK
E_FAIL
o GetMergeable
| public virtual GetMergeable( | | oMergeable) |
-
Get the underlying feature
- Parameters:
-
- oMergeable
- [out, CATBaseUnknown#Release] the underlying feature
o GetReferenceBriefcase
| public virtual GetReferenceBriefcase( | | oBriefcase) |
-
Get the briefcase owning the merge item
- Parameters:
-
- oBriefcase
- [out, CATBaseUnknown#Release]
- Returns:
- S_OK
E_FAIL
o GetShareMode
| public virtual GetShareMode( | | oShareMode) |
-
Get the share mode defined during the share step. See
CATIcolSharable
o GetVisibility
| public virtual GetVisibility( | | oVisibleState) |
-
Get the visibility of the feature inside the collaborative application
o HaveBeenLocated
| public virtual HaveBeenLocated( | | oIsLocated) |
-
Is there a version of the feature hold by the merge item inside the destination document ?
- Parameters:
-
- oIsLocated
- TRUE : feature has been found
FALSE : feature has not been found
o HaveBeenModified
| public virtual HaveBeenModified( | | oIsModified) |
-
If the feature has been retrieved, this methods says if there is a difference between the version
inside the briefcase and the version inside the destination document
- Parameters:
-
- oIsModified
- TRUE : feature has been modified
FALSE : feature has not been modified
o HaveBeenShared
| public virtual HaveBeenShared( | | oIsShared) |
-
Has the feature been explicitly put inside the briefcase ?
- Parameters:
-
- oIsShared
- TRUE : feature has been put explicitly
FALSE : feature has not been put as a dependency
o SetMergeFlag
| public virtual SetMergeFlag( | | iMergeFlag) |
-
Set the merge flag :
- Parameters:
-
- iMergeFlag
- merge flag value
- Returns:
- S_OK
E_FAIL
Enumerated Types
o MergeFlag
-
enum MergeFlag {
NO_MERGE,
MERGE,
MERGE_IF_NEEDED,
CREATE,
MERGED,
REMOVE
}
Defines the action which can be set to a merge item
- NO_MERGE : if the feature exists in the destination part, it won't be replaced
- MERGE : replace if exist, create if not
- MERGE_IF_NEEDED : not used
- CREATE : same than merge
- MERGE : the merge item has been processed
This object is included in the file: CATIColMergeItem.h
If needed, your Imakefile.mk should include the module: CATInstantCollabDesignItf