Project: stp

com.ibm.rational.wvcm.stp.cc
Interface CcMergeElement


public interface CcMergeElement

An interface used to track the status of a Merge operation. This object is used by integration operations to maintain state through each phase of the operation. For example, from CcView.doStartDeliver() to CcView.doCompleteDeliver().


Nested Class Summary
static class CcMergeElement.MergeInterventionType
          Before the merge stage, the MergeInterventionType will either be TRIVIAL or NON_TRIVIAL.
static class CcMergeElement.MergeState
          Enumerated states to determine if a merge is needed.
 
Method Summary
 CcFile doCheckout(CcFile.CcCheckoutFlag[] coFlags, Feedback feedback)
          Utility method to request the underlying CcFile object to be checked out for merge.
 CcFile doReadProperties(Feedback wantedProps)
          Provides an accessor to the underlying CcFile object for this MergeElement.
 String getBaseVersionExtendedPathname()
          Retrieve the base version contributor.
 CcElementType.MergeType getElementMergeType()
          Returns the type of merge needed for this element.
 String getFromVersionExtendedPathname()
          Retrieve the from version contributor.
 boolean getIsDirectory()
          Is this element a directory?
 boolean getIsVisible()
          Determine whether this element is visible to the current view.
 CcMergeElement.MergeInterventionType getMergeInterventionType()
          Returns the type of merge needed.
 CcMergeElement.MergeState getMergeState()
          Retrieve whether a merge is needed or not
 CcProvider getProvider()
          Get the provider proxy for the underlying CcFile for this element
 String getToVersionExtendedPathname()
          Retrieve the to version contributor.
 String getTypeManager()
          Determine the file type for this element.
 String getViewRelativePathname()
          Retrieve the view relative pathname for this element
 

Method Detail

doCheckout

CcFile doCheckout(CcFile.CcCheckoutFlag[] coFlags,
                  Feedback feedback)
                  throws WvcmException
Utility method to request the underlying CcFile object to be checked out for merge.

Parameters:
coFlags - Checkout flags
feedback - properties to be requested
Returns:
new proxy to the underlying file with requested properties
Throws:
WvcmException

doReadProperties

CcFile doReadProperties(Feedback wantedProps)
                        throws WvcmException
Provides an accessor to the underlying CcFile object for this MergeElement. Use this method to request properties.

Parameters:
wantedProps - props to be fetched
Returns:
a new proxy for the underlying CcFile
Throws:
WvcmException

getBaseVersionExtendedPathname

String getBaseVersionExtendedPathname()
Retrieve the base version contributor. May be null.

Returns:
String version extended pathname of the base version

getElementMergeType

CcElementType.MergeType getElementMergeType()
Returns the type of merge needed for this element. This will reveal if this element is marked as a USER merge or NEVER merge type.

Returns:
ElementMergeType

getFromVersionExtendedPathname

String getFromVersionExtendedPathname()
Retrieve the from version contributor.

Returns:
String version extended pathname of the from version

getIsDirectory

boolean getIsDirectory()
Is this element a directory?

Returns:
true if the element is a directory

getIsVisible

boolean getIsVisible()
Determine whether this element is visible to the current view.

Returns:
true if the element is visible

getMergeInterventionType

CcMergeElement.MergeInterventionType getMergeInterventionType()
Returns the type of merge needed.

Returns:
MergeInterventionType describing the type of merge
See Also:
CcMergeElement.MergeInterventionType

getMergeState

CcMergeElement.MergeState getMergeState()
Retrieve whether a merge is needed or not

Returns:
MergeState describing the element merge

getProvider

CcProvider getProvider()
Get the provider proxy for the underlying CcFile for this element

Returns:
CcProvider proxy

getToVersionExtendedPathname

String getToVersionExtendedPathname()
Retrieve the to version contributor.

Returns:
String version extended pathname of the to version

getTypeManager

String getTypeManager()
Determine the file type for this element. This is the file type used to determine which type manager to use for the merge handler.

Returns:
String of file type (ie. text-delta)

getViewRelativePathname

String getViewRelativePathname()
                               throws WvcmException
Retrieve the view relative pathname for this element

Returns:
String pathname to this object
Throws:
WvcmException

Generated Fri 20-Feb-2015 11:07 PM

Copyright © IBM 2015. All rights reserved.