com.esri.arcgis.schematic
Interface ISchematicExpandLinksByAttributeRule

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISchematicExpandLinksByAttributeRuleProxy, SchematicExpandLinksByAttributeRule

public interface ISchematicExpandLinksByAttributeRule
extends java.io.Serializable

COM Interface 'ISchematicExpandLinksByAttributeRule'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that manage the Expand link by attribute rule.' 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

static java.lang.String	IID Deprecated. Internal use only
static int	IID460616a4_1363_4737_98b7_c476e4f8acca
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getExtendedCriteriaName() Name of the extended criteria which gives the number of expected links.
java.lang.String	getField() Field name of the associated feature giving the number of expected expanded links.
int	getFieldFormat() Format of the field giving the number of expected expanded links.
java.lang.String	getLinkElementClassName() Name of the schematic link class to expand.
java.lang.String	getRangeValuesSeparator() Range values separator character.
java.lang.String	getSetOfCharactersSeparator() List of Characters Separator character.
java.lang.String	getStorageName() Name of the field used to store the decoded value of the expanded link (optional).
java.lang.String	getWhereClause() Where clause used on associated feature to filter the schematic links expand.
boolean	isExtendedCriteria() Indicates if an extended criteria is used to get the number of expected links.
boolean	isKeepLinksWithNoValue() Indicates if the rule keeps Links which field has no value.
boolean	isUseCodeName() Indicates if the code name (or domain name) should be used to get the number of expected expanded links.
void	setDescription(java.lang.String rhs1) Description of the Schematic Expand link by attribute rule.
void	setExtendedCriteria(boolean extendedCriteria) Indicates if an extended criteria is used to get the number of expected links.
void	setExtendedCriteriaName(java.lang.String extendedCriteriaName) Name of the extended criteria which gives the number of expected links.
void	setField(java.lang.String field) Field name of the associated feature giving the number of expected expanded links.
void	setFieldFormat(int fieldFormat) Format of the field giving the number of expected expanded links.
void	setKeepLinksWithNoValue(boolean keepLinksWithNoValue) Indicates if the rule keeps Links which field has no value.
void	setLinkElementClassName(java.lang.String linkElementClassName) Name of the schematic link class to expand.
void	setRangeValuesSeparator(java.lang.String separator) Range values separator character.
void	setSetOfCharactersSeparator(java.lang.String separator) List of Characters Separator character.
void	setStorageName(java.lang.String storageName) Name of the field used to store the decoded value of the expanded link (optional).
void	setUseCodeName(boolean useCodeName) Indicates if the code name (or domain name) should be used to get the number of expected expanded links.
void	setWhereClause(java.lang.String whereClause) Where clause used on associated feature to filter the schematic links expand.

Field Detail

IID460616a4_1363_4737_98b7_c476e4f8acca

static final int IID460616a4_1363_4737_98b7_c476e4f8acca

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

setDescription

void setDescription(java.lang.String rhs1)
                    throws java.io.IOException,
                           AutomationException

Description of the Schematic Expand link by attribute rule.

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

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

Field name of the associated feature giving the number of expected expanded links.

Returns:

The field

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setField

void setField(java.lang.String field)
              throws java.io.IOException,
                     AutomationException

Field name of the associated feature giving the number of expected expanded links.

Parameters:

field - The field (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldFormat

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

Format of the field giving the number of expected expanded links.

Returns:

The fieldFormat

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldFormat

void setFieldFormat(int fieldFormat)
                    throws java.io.IOException,
                           AutomationException

Format of the field giving the number of expected expanded links.

Parameters:

fieldFormat - The fieldFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSetOfCharactersSeparator

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

List of Characters Separator character.

Returns:

The separator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSetOfCharactersSeparator

void setSetOfCharactersSeparator(java.lang.String separator)
                                 throws java.io.IOException,
                                        AutomationException

List of Characters Separator character.

Parameters:

separator - The separator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRangeValuesSeparator

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

Range values separator character.

Returns:

The separator

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRangeValuesSeparator

void setRangeValuesSeparator(java.lang.String separator)
                             throws java.io.IOException,
                                    AutomationException

Range values separator character.

Parameters:

separator - The separator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStorageName

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

Name of the field used to store the decoded value of the expanded link (optional).

Returns:

The storageName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStorageName

void setStorageName(java.lang.String storageName)
                    throws java.io.IOException,
                           AutomationException

Name of the field used to store the decoded value of the expanded link (optional).

Parameters:

storageName - The storageName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isExtendedCriteria

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

Indicates if an extended criteria is used to get the number of expected links. In this case, the property 'Field' is not used.

Returns:

The extendedCriteria

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteria

void setExtendedCriteria(boolean extendedCriteria)
                         throws java.io.IOException,
                                AutomationException

Indicates if an extended criteria is used to get the number of expected links. In this case, the property 'Field' is not used.

Parameters:

extendedCriteria - The extendedCriteria (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtendedCriteriaName

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

Name of the extended criteria which gives the number of expected links.

Returns:

The extendedCriteriaName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaName

void setExtendedCriteriaName(java.lang.String extendedCriteriaName)
                             throws java.io.IOException,
                                    AutomationException

Name of the extended criteria which gives the number of expected links.

Parameters:

extendedCriteriaName - The extendedCriteriaName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLinkElementClassName

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

Name of the schematic link class to expand.

Returns:

The linkElementClassName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLinkElementClassName

void setLinkElementClassName(java.lang.String linkElementClassName)
                             throws java.io.IOException,
                                    AutomationException

Name of the schematic link class to expand.

Parameters:

linkElementClassName - The linkElementClassName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWhereClause

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

Where clause used on associated feature to filter the schematic links expand.

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException

Where clause used on associated feature to filter the schematic links expand.

Parameters:

whereClause - The whereClause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isKeepLinksWithNoValue

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

Indicates if the rule keeps Links which field has no value.

Returns:

The keepLinksWithNoValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeepLinksWithNoValue

void setKeepLinksWithNoValue(boolean keepLinksWithNoValue)
                             throws java.io.IOException,
                                    AutomationException

Indicates if the rule keeps Links which field has no value.

Parameters:

keepLinksWithNoValue - The keepLinksWithNoValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseCodeName

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

Indicates if the code name (or domain name) should be used to get the number of expected expanded links.

Returns:

The useCodeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseCodeName

void setUseCodeName(boolean useCodeName)
                    throws java.io.IOException,
                           AutomationException

Indicates if the code name (or domain name) should be used to get the number of expected expanded links.

Parameters:

useCodeName - The useCodeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.