com.esri.arcgis.geodatabase

Class IShieldsProxy

java.lang.Object

com.esri.arcgis.interop.Dispatch

com.esri.arcgis.geodatabase.IShieldsProxy

All Implemented Interfaces:

IShields, java.io.Externalizable, java.io.Serializable

public class IShieldsProxy
extends com.esri.arcgis.interop.Dispatch
implements IShields, java.io.Serializable

Internal use class Proxy for COM Interface 'IShields'. Generated 9/21/2023 10:01:47 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to a container for refining directions with shields.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.geodatabase.IShields

IID, IID9e82750b_bddc_40a1_9a63_ff699ffc55e1

Constructor Summary

Constructors

Modifier	Constructor and Description
	IShieldsProxy() For internal use only
	IShieldsProxy(java.lang.Object obj)
protected	IShieldsProxy(java.lang.Object obj, java.lang.String iid)
	IShieldsProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IShieldsProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
void	addShield(java.lang.String type, java.lang.String description) Adds a shield of the given type.
void	deleteShield(int index) Deletes a shield by index.
java.lang.String	getCombinedFieldName() The field name whose values contain the whole address description.
java.lang.String	getNumberFieldName() The field name whose values contain the house number.
int	getShieldCount() The number of shields.
java.lang.String	getShieldDescription(int index) The shield description by index.
java.lang.String	getShieldType(int index) The shield type by index.
java.lang.String	getTypeFieldName() The field name whose values contain the street type.
boolean	isUseCombinedField() Indicates if the combined field should be used for directions.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	setCombinedFieldName(java.lang.String name) The field name whose values contain the whole address description.
void	setNumberFieldName(java.lang.String name) The field name whose values contain the house number.
void	setTypeFieldName(java.lang.String name) The field name whose values contain the street type.
void	setUseCombinedField(boolean useCombined) Indicates if the combined field should be used for directions.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IShieldsProxy

public IShieldsProxy(java.lang.String CLSID,
                     java.lang.String host,
                     com.esri.arcgis.interop.AuthInfo authInfo)
              throws java.net.UnknownHostException,
                     java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IShieldsProxy

public IShieldsProxy()

For internal use only

IShieldsProxy

public IShieldsProxy(java.lang.Object obj)
              throws java.io.IOException

Throws:

java.io.IOException

IShieldsProxy

protected IShieldsProxy(java.lang.Object obj,
                        java.lang.String iid)
                 throws java.io.IOException

Throws:

java.io.IOException

IShieldsProxy

protected IShieldsProxy(java.lang.String CLSID,
                        java.lang.String iid,
                        java.lang.String host,
                        com.esri.arcgis.interop.AuthInfo authInfo)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: com.esri.arcgis.interop.Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: com.esri.arcgis.interop.Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

getTypeFieldName

public java.lang.String getTypeFieldName()
                                  throws java.io.IOException,
                                         AutomationException

The field name whose values contain the street type.

Specified by:

getTypeFieldName in interface IShields

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeFieldName

public void setTypeFieldName(java.lang.String name)
                      throws java.io.IOException,
                             AutomationException

The field name whose values contain the street type.

Specified by:

setTypeFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFieldName

public java.lang.String getNumberFieldName()
                                    throws java.io.IOException,
                                           AutomationException

The field name whose values contain the house number.

Specified by:

getNumberFieldName in interface IShields

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNumberFieldName

public void setNumberFieldName(java.lang.String name)
                        throws java.io.IOException,
                               AutomationException

The field name whose values contain the house number.

Specified by:

setNumberFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCombinedFieldName

public java.lang.String getCombinedFieldName()
                                      throws java.io.IOException,
                                             AutomationException

The field name whose values contain the whole address description.

Specified by:

getCombinedFieldName in interface IShields

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCombinedFieldName

public void setCombinedFieldName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The field name whose values contain the whole address description.

Specified by:

setCombinedFieldName in interface IShields

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseCombinedField

public boolean isUseCombinedField()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the combined field should be used for directions.

Specified by:

isUseCombinedField in interface IShields

Returns:

The useCombined

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseCombinedField

public void setUseCombinedField(boolean useCombined)
                         throws java.io.IOException,
                                AutomationException

Indicates if the combined field should be used for directions.

Specified by:

setUseCombinedField in interface IShields

Parameters:

useCombined - The useCombined (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldCount

public int getShieldCount()
                   throws java.io.IOException,
                          AutomationException

The number of shields.

Specified by:

getShieldCount in interface IShields

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldType

public java.lang.String getShieldType(int index)
                               throws java.io.IOException,
                                      AutomationException

The shield type by index.

Specified by:

getShieldType in interface IShields

Parameters:

index - The index (in)

Returns:

The type

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShieldDescription

public java.lang.String getShieldDescription(int index)
                                      throws java.io.IOException,
                                             AutomationException

The shield description by index.

Specified by:

getShieldDescription in interface IShields

Parameters:

index - The index (in)

Returns:

The type

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addShield

public void addShield(java.lang.String type,
                      java.lang.String description)
               throws java.io.IOException,
                      AutomationException

Adds a shield of the given type.

Specified by:

addShield in interface IShields

Parameters:

type - The type (in)

description - The description (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteShield

public void deleteShield(int index)
                  throws java.io.IOException,
                         AutomationException

Deletes a shield by index.

Specified by:

deleteShield in interface IShields

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.