com.esri.arcgis.editor
Class ConflictsWindow

java.lang.Object
  extended by com.esri.arcgis.editor.ConflictsWindow
All Implemented Interfaces:
IConflictDisplay, IConflictsWindow, IConflictsWindow2, IConflictsWindow3, com.esri.arcgis.interop.RemoteObjRef, IExtension, Serializable

public class ConflictsWindow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IConflictsWindow, IConflictsWindow2, IConflictsWindow3, IConflictDisplay, IExtension

Window used to resolve versioning conflicts.

Remarks

ConflictsWindow is an extension that presents the conflicts between the current edit version, the version the edits are being saved into, and the original state of the editorís data when its edit session first started. Conflicts arise when features are modified by more than one person. For example, if two people start an edit session on the same
version and edit the same feature, the last editor to save the modifications will get a conflict that must be resolved if any edits made are to be committed to the database.

Use IEditor::FindExtension to access the ConflictsWindow class programmatically.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.system.IExtension
IID, IID7f657ec9_dbf1_11d2_9f2f_00c04f6bc69e, xxDummy
 
Constructor Summary
ConflictsWindow(Object obj)
          Construct a ConflictsWindow using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IConflictClass esri_getClass(int index)
          Class by index.
 ITable findTable(IConflictClass conflictClass, int vers)
          Finds a cached table corresponding to the conflict class and version.
 int getClassCount()
          The number of classes with conflicts.
 IConflictClass getCurrentClass()
          Class of the selected feature, or 0 if no ConflictClass.
 int getCurrentRow()
          ID of the selected row or feature, or -1 if no current row.
 IFillSymbol getFillSymbol(int vers)
          Display symbol used to draw polygon features.
 IEnumIDs getIDs(IConflictClass conflictClass)
          Enumerate the feature IDs for a ConflictClass.
 ILineSymbol getLineSymbol(int vers)
          Display symbol used to draw line features.
 IMarkerSymbol getMarkerSymbol(int vers)
          Display symbol used to draw point features.
 String getName()
          The name of the extension.
 ILongArray getSelectedFieldIndexes()
          The indexes of the fields in the row that are currently selected.
 boolean hasConflicts()
          Indicates if conflicts have been detected.
 int hashCode()
          the hashcode for this object
 boolean isCurrentVisited()
          Indicates whether the visited state of the current selected tree item.
 boolean isShowOnConflictsDetected()
          Indicates whether the conficts window is displayed when a conflicts event is fired.
 boolean isVersionVisible(int vers)
          Indicates whether the specified version is visible in the conflicts window.
 boolean isVisible()
          Indicates if Conflicts Window is visible.
 void removeClass(IConflictClass conflictClass)
          Removes the conlict class from the window.
 void reset()
          Resets the conflicts.
 void setCurrentVisited(boolean visited)
          Indicates whether the visited state of the current selected tree item.
 void setFillSymbolByRef(int vers, IFillSymbol symbol)
          Display symbol used to draw polygon features.
 void setLineSymbolByRef(int vers, ILineSymbol symbol)
          Display symbol used to draw line features.
 void setMarkerSymbolByRef(int vers, IMarkerSymbol symbol)
          Display symbol used to draw point features.
 void setShowOnConflictsDetected(boolean showWindow)
          Indicates whether the conficts window is displayed when a conflicts event is fired.
 void setVersionVisible(int vers, boolean visible)
          Indicates whether the specified version is visible in the conflicts window.
 void setVisible(boolean vis)
          Indicates if Conflicts Window is visible.
 void shutdown()
          Shuts down the extension.
 void startup(Object initializationData)
          Starts up the extension with the given initialization data.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ConflictsWindow

public ConflictsWindow(Object obj)
                throws IOException
Construct a ConflictsWindow using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ConflictsWindow.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ConflictsWindow o = (ConflictsWindow)obj; // will not work

ConflictsWindow o = new ConflictsWindow(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ConflictsWindow theConflictsWindow = (ConflictsWindow) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setVisible

public void setVisible(boolean vis)
                throws IOException,
                       AutomationException
Indicates if Conflicts Window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setVisible in interface IConflictsWindow
Parameters:
vis - The vis (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException
Indicates if Conflicts Window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
isVisible in interface IConflictsWindow
Returns:
The vis
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasConflicts

public boolean hasConflicts()
                     throws IOException,
                            AutomationException
Indicates if conflicts have been detected.

Remarks

HasConflicts returns True if any classes are returned by IVersionEdit::ConflictClasses.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
hasConflicts in interface IConflictsWindow
Returns:
The conflicts
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentRow

public int getCurrentRow()
                  throws IOException,
                         AutomationException
ID of the selected row or feature, or -1 if no current row.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getCurrentRow in interface IConflictsWindow
Returns:
The fid
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentClass

public IConflictClass getCurrentClass()
                               throws IOException,
                                      AutomationException
Class of the selected feature, or 0 if no ConflictClass.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getCurrentClass in interface IConflictsWindow
Returns:
A reference to a com.esri.arcgis.geodatabase.IConflictClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassCount

public int getClassCount()
                  throws IOException,
                         AutomationException
The number of classes with conflicts.

Remarks

Use ClassCount to loop over the set of conflict classes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getClassCount in interface IConflictsWindow
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

public IConflictClass esri_getClass(int index)
                             throws IOException,
                                    AutomationException
Class by index.

Product Availability

Available with ArcGIS Desktop.

Specified by:
esri_getClass in interface IConflictsWindow
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IConflictClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIDs

public IEnumIDs getIDs(IConflictClass conflictClass)
                throws IOException,
                       AutomationException
Enumerate the feature IDs for a ConflictClass.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getIDs in interface IConflictsWindow
Parameters:
conflictClass - A reference to a com.esri.arcgis.geodatabase.IConflictClass (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumIDs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Resets the conflicts.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
reset in interface IConflictsWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findTable

public ITable findTable(IConflictClass conflictClass,
                        int vers)
                 throws IOException,
                        AutomationException
Finds a cached table corresponding to the conflict class and version.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
findTable in interface IConflictsWindow
Parameters:
conflictClass - A reference to a com.esri.arcgis.geodatabase.IConflictClass (in)
vers - A com.esri.arcgis.editor.esriVersion constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeClass

public void removeClass(IConflictClass conflictClass)
                 throws IOException,
                        AutomationException
Removes the conlict class from the window.

Remarks

Issuing RemoveClass provides a way to filter the list of conflicts presented to the user; it does not resolve conflicts from that class. Use IConflictsWindow::Reset to populate the conflict window with all conflict classes removed using RemoveClass.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
removeClass in interface IConflictsWindow2
Parameters:
conflictClass - A reference to a com.esri.arcgis.geodatabase.IConflictClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowOnConflictsDetected

public void setShowOnConflictsDetected(boolean showWindow)
                                throws IOException,
                                       AutomationException
Indicates whether the conficts window is displayed when a conflicts event is fired.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setShowOnConflictsDetected in interface IConflictsWindow3
Parameters:
showWindow - The showWindow (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowOnConflictsDetected

public boolean isShowOnConflictsDetected()
                                  throws IOException,
                                         AutomationException
Indicates whether the conficts window is displayed when a conflicts event is fired.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isShowOnConflictsDetected in interface IConflictsWindow3
Returns:
The showWindow
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSelectedFieldIndexes

public ILongArray getSelectedFieldIndexes()
                                   throws IOException,
                                          AutomationException
The indexes of the fields in the row that are currently selected.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getSelectedFieldIndexes in interface IConflictsWindow3
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCurrentVisited

public boolean isCurrentVisited()
                         throws IOException,
                                AutomationException
Indicates whether the visited state of the current selected tree item.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isCurrentVisited in interface IConflictsWindow3
Returns:
The visited
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentVisited

public void setCurrentVisited(boolean visited)
                       throws IOException,
                              AutomationException
Indicates whether the visited state of the current selected tree item.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setCurrentVisited in interface IConflictsWindow3
Parameters:
visited - The visited (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isVersionVisible

public boolean isVersionVisible(int vers)
                         throws IOException,
                                AutomationException
Indicates whether the specified version is visible in the conflicts window.

Product Availability

Available with ArcGIS Desktop.

Specified by:
isVersionVisible in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVersionVisible

public void setVersionVisible(int vers,
                              boolean visible)
                       throws IOException,
                              AutomationException
Indicates whether the specified version is visible in the conflicts window.

Product Availability

Available with ArcGIS Desktop.

Specified by:
setVersionVisible in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol(int vers)
                              throws IOException,
                                     AutomationException
Display symbol used to draw point features.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getMarkerSymbol in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
Returns:
A reference to a com.esri.arcgis.display.IMarkerSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMarkerSymbolByRef

public void setMarkerSymbolByRef(int vers,
                                 IMarkerSymbol symbol)
                          throws IOException,
                                 AutomationException
Display symbol used to draw point features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setMarkerSymbolByRef in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol(int vers)
                          throws IOException,
                                 AutomationException
Display symbol used to draw line features.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getLineSymbol in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
Returns:
A reference to a com.esri.arcgis.display.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineSymbolByRef

public void setLineSymbolByRef(int vers,
                               ILineSymbol symbol)
                        throws IOException,
                               AutomationException
Display symbol used to draw line features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setLineSymbolByRef in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol(int vers)
                          throws IOException,
                                 AutomationException
Display symbol used to draw polygon features.

Product Availability

Available with ArcGIS Desktop.

Specified by:
getFillSymbol in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
Returns:
A reference to a com.esri.arcgis.display.IFillSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFillSymbolByRef

public void setFillSymbolByRef(int vers,
                               IFillSymbol symbol)
                        throws IOException,
                               AutomationException
Display symbol used to draw polygon features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setFillSymbolByRef in interface IConflictDisplay
Parameters:
vers - A com.esri.arcgis.editor.esriVersion constant (in)
symbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the extension.

Specified by:
getName in interface IExtension
Returns:
The extensionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startup

public void startup(Object initializationData)
             throws IOException,
                    AutomationException
Starts up the extension with the given initialization data.

Specified by:
startup in interface IExtension
Parameters:
initializationData - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException
Shuts down the extension.

Specified by:
shutdown in interface IExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.