com.esri.arcgis.schematic
Class NgElementTypeEffect

java.lang.Object
  extended by com.esri.arcgis.schematic.NgElementTypeEffect
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INgElementTypeEffect, ISupportErrorInfo, Serializable

public class NgElementTypeEffect
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgElementTypeEffect, ISupportErrorInfo

Element type effect object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
NgElementTypeEffect()
          Constructs a NgElementTypeEffect using ArcGIS Engine.
NgElementTypeEffect(Object obj)
          Construct a NgElementTypeEffect using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getEffectType()
          Type of effect (see esriNgElementTypeEffect).
 Object getEffectValue()
          Value of the effect.
 String getSubSymbolName()
          Name of the sub-symbol on which the effect applies.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 
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

NgElementTypeEffect

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

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

NgElementTypeEffect

public NgElementTypeEffect(Object obj)
                    throws IOException
Construct a NgElementTypeEffect using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgElementTypeEffect.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems NgElementTypeEffect theNgElementTypeEffect = (NgElementTypeEffect) obj;
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

getEffectType

public int getEffectType()
                  throws IOException,
                         AutomationException
Type of effect (see esriNgElementTypeEffect).

Description

The value set for this effect is defined by the EffectValue property. If the SubSymbolName property is set, the effect type applies to the associated sub-symbol.

Product Availability

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

Specified by:
getEffectType in interface INgElementTypeEffect
Returns:
A com.esri.arcgis.schematic.esriNgElementTypeEffect constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEffectValue

public Object getEffectValue()
                      throws IOException,
                             AutomationException
Value of the effect.

Product Availability

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

Specified by:
getEffectValue in interface INgElementTypeEffect
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubSymbolName

public String getSubSymbolName()
                        throws IOException,
                               AutomationException
Name of the sub-symbol on which the effect applies.

Description

If this property is set, the EffectType and EffectValue properties apply to the sub-symbol.

Product Availability

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

Specified by:
getSubSymbolName in interface INgElementTypeEffect
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.