com.esri.arcgis.schematic
Class SchematicCallbackBuilder

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicCallbackBuilder
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicBuilder, ISchematicBuilderDescription, ISchematicBuilderEdit, ISchematicBuilderProps, Serializable

public class SchematicCallbackBuilder
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicBuilder, ISchematicBuilderEdit, ISchematicBuilderProps, ISchematicBuilderDescription

Schematic Callback builder object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
SchematicCallbackBuilder()
          Constructs a SchematicCallbackBuilder using ArcGIS Engine.
SchematicCallbackBuilder(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicCallbackBuilder theSchematicCallbackBuilder = (SchematicCallbackBuilder) obj;
 
Method Summary
 boolean canCopyDiagram(ISchematicDiagram diagram)
          Indicates if the schematic diagram implemented by the schematic diagram builder can be copied.
 boolean canDeleteDiagram(ISchematicDiagram diagram)
          Indicates if the schematic diagram implemented by the schematic diagram builder can be deleted.
 boolean canDeleteElement(ISchematicDiagram diagram)
          Indicates if schematic element managed by the schematic diagram builder can be deleted.
 boolean canRenameDiagram(ISchematicDiagram diagram)
          Indicates if the schematic diagram implemented by the schematic diaram builder can be renamed.
 IDataset copyDiagram(ISchematicDiagram diagram, String copyName, ISchematicDiagramContainer container, ITrackCancel cancelTracker)
          Copies the schematic diagram implemented by the schematic diagram builder under antoher name in the specified schematic diagrams container.
 void deleteElement(ISchematicDiagram diagram, INgElement pNgElement)
          Deletes a schematic element belonging to a schematic diagram implemented by the schematic diagram builder.
 boolean equals(Object o)
          Compare this object with another
 ISchematicDiagram generateDiagram(String diagramName, ISchematicDiagramContainer diagramContainer, IPropertySet pPropertySet, ISchematicBuilderContext pContext, ITrackCancel cancelTracker)
          Generates a new schematic diagram implemented by the schematic diagram builder.
 IUID getClassID()
          ClassID of the schematic builder.
static String getClsid()
          getClsid.
 String getName()
          Name of the schematic builder.
 IPropertySet getPropertySet()
          PropertySet related to the schematic builder.
 ISchematicDiagramClass getSchematicDiagramClass()
          Schematic diagram class related to the schematic builder.
 int hashCode()
          the hashcode for this object
 void onDeleteDiagram(ISchematicDiagram diagram)
          Deletes the schematic diagram implemented by the schematic diagram builder.
 void onRenameDiagram(ISchematicDiagram diagram, String newName)
          Renames the schematic diagram implemented by the schematic diagram builder.
 void setPropertySet(IPropertySet propertySet)
          PropertySet related to the schematic builder.
 void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
          Schematic diagram class related to the schematic builder.
 void updateDiagram(ISchematicDiagram diagram, IPropertySet pPropertySet, ISchematicBuilderContext pContext, ITrackCancel cancelTracker)
          Refreshs an existing diagram implemented by the schematic diagram builder.
 
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

SchematicCallbackBuilder

public SchematicCallbackBuilder()
                         throws IOException,
                                UnknownHostException
Constructs a SchematicCallbackBuilder using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

SchematicCallbackBuilder

public SchematicCallbackBuilder(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicCallbackBuilder theSchematicCallbackBuilder = (SchematicCallbackBuilder) obj;

Construct a SchematicCallbackBuilder using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicCallbackBuilder.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


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

generateDiagram

public ISchematicDiagram generateDiagram(String diagramName,
                                         ISchematicDiagramContainer diagramContainer,
                                         IPropertySet pPropertySet,
                                         ISchematicBuilderContext pContext,
                                         ITrackCancel cancelTracker)
                                  throws IOException,
                                         AutomationException
Generates a new schematic diagram implemented by the schematic diagram builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
generateDiagram in interface ISchematicBuilder
Parameters:
diagramName - The diagramName (in)
diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in, optional, pass null if not required)
pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in, optional, pass null if not required)
pContext - A reference to a com.esri.arcgis.schematic.ISchematicBuilderContext (in, optional, pass null if not required)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagram
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateDiagram

public void updateDiagram(ISchematicDiagram diagram,
                          IPropertySet pPropertySet,
                          ISchematicBuilderContext pContext,
                          ITrackCancel cancelTracker)
                   throws IOException,
                          AutomationException
Refreshs an existing diagram implemented by the schematic diagram builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
updateDiagram in interface ISchematicBuilder
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in, optional, pass null if not required)
pContext - A reference to a com.esri.arcgis.schematic.ISchematicBuilderContext (in, optional, pass null if not required)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDeleteDiagram

public boolean canDeleteDiagram(ISchematicDiagram diagram)
                         throws IOException,
                                AutomationException
Indicates if the schematic diagram implemented by the schematic diagram builder can be deleted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
canDeleteDiagram in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Returns:
The canDelete
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.onDeleteDiagram(com.esri.arcgis.schematic.ISchematicDiagram), ISchematicBuilderEdit.canDeleteElement(com.esri.arcgis.schematic.ISchematicDiagram)

onDeleteDiagram

public void onDeleteDiagram(ISchematicDiagram diagram)
                     throws IOException,
                            AutomationException
Deletes the schematic diagram implemented by the schematic diagram builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
onDeleteDiagram in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.canDeleteDiagram(com.esri.arcgis.schematic.ISchematicDiagram)

canRenameDiagram

public boolean canRenameDiagram(ISchematicDiagram diagram)
                         throws IOException,
                                AutomationException
Indicates if the schematic diagram implemented by the schematic diaram builder can be renamed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
canRenameDiagram in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Returns:
The canRename
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.onRenameDiagram(com.esri.arcgis.schematic.ISchematicDiagram, String), ISchematicBuilderEdit.canCopyDiagram(com.esri.arcgis.schematic.ISchematicDiagram)

onRenameDiagram

public void onRenameDiagram(ISchematicDiagram diagram,
                            String newName)
                     throws IOException,
                            AutomationException
Renames the schematic diagram implemented by the schematic diagram builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
onRenameDiagram in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
newName - The newName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.canRenameDiagram(com.esri.arcgis.schematic.ISchematicDiagram)

canCopyDiagram

public boolean canCopyDiagram(ISchematicDiagram diagram)
                       throws IOException,
                              AutomationException
Indicates if the schematic diagram implemented by the schematic diagram builder can be copied.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
canCopyDiagram in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Returns:
The canCopy
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.copyDiagram(com.esri.arcgis.schematic.ISchematicDiagram, String, com.esri.arcgis.schematic.ISchematicDiagramContainer, com.esri.arcgis.system.ITrackCancel)

copyDiagram

public IDataset copyDiagram(ISchematicDiagram diagram,
                            String copyName,
                            ISchematicDiagramContainer container,
                            ITrackCancel cancelTracker)
                     throws IOException,
                            AutomationException
Copies the schematic diagram implemented by the schematic diagram builder under antoher name in the specified schematic diagrams container.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
copyDiagram in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
copyName - The copyName (in)
container - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.canCopyDiagram(com.esri.arcgis.schematic.ISchematicDiagram)

canDeleteElement

public boolean canDeleteElement(ISchematicDiagram diagram)
                         throws IOException,
                                AutomationException
Indicates if schematic element managed by the schematic diagram builder can be deleted.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
canDeleteElement in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
Returns:
The canDelete
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit.canDeleteDiagram(com.esri.arcgis.schematic.ISchematicDiagram), ISchematicBuilderEdit.deleteElement(com.esri.arcgis.schematic.ISchematicDiagram, com.esri.arcgis.schematic.INgElement)

deleteElement

public void deleteElement(ISchematicDiagram diagram,
                          INgElement pNgElement)
                   throws IOException,
                          AutomationException
Deletes a schematic element belonging to a schematic diagram implemented by the schematic diagram builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
deleteElement in interface ISchematicBuilderEdit
Parameters:
diagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)
pNgElement - A reference to a com.esri.arcgis.schematic.INgElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderEdit, ISchematicBuilderEdit.canDeleteElement(com.esri.arcgis.schematic.ISchematicDiagram)

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException
PropertySet related to the schematic builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

setPropertySet

public void setPropertySet(IPropertySet propertySet)
                    throws IOException,
                           AutomationException
PropertySet related to the schematic builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setPropertySet in interface ISchematicBuilderProps
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException
Schematic diagram class related to the schematic builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getSchematicDiagramClass in interface ISchematicBuilderProps
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassByRef

public void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
                                   throws IOException,
                                          AutomationException
Schematic diagram class related to the schematic builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setSchematicDiagramClassByRef in interface ISchematicBuilderProps
Parameters:
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the schematic builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getName in interface ISchematicBuilderDescription
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderDescription.getClassID()

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException
ClassID of the schematic builder.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getClassID in interface ISchematicBuilderDescription
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ISchematicBuilderDescription.getName()