com.esri.arcgis.geodatabase

Interface IShields

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IShieldsProxy

public interface IShields
extends java.io.Serializable

COM Interface 'IShields'. Generated 9/24/2024 11:01:30 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID9e82750b_bddc_40a1_9a63_ff699ffc55e1
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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	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.

Field Detail

IID9e82750b_bddc_40a1_9a63_ff699ffc55e1

static final int IID9e82750b_bddc_40a1_9a63_ff699ffc55e1

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getTypeFieldName

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

The field name whose values contain the street type.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTypeFieldName

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

The field name whose values contain the street type.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberFieldName

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

The field name whose values contain the house number.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberFieldName

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

The field name whose values contain the house number.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCombinedFieldName

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

The field name whose values contain the whole address description.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCombinedFieldName

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

The field name whose values contain the whole address description.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseCombinedField

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

Indicates if the combined field should be used for directions.

Returns:

The useCombined

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseCombinedField

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

Indicates if the combined field should be used for directions.

Parameters:

useCombined - The useCombined (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShieldCount

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

The number of shields.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShieldType

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

The shield type by index.

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

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

The shield description by index.

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

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

Adds a shield of the given type.

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

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

Deletes a shield by index.

Parameters:

index - The index (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.