com.esri.arcgis.search
Interface ISearchConfiguration

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ISearchConfigurationProxy, SearchConfiguration

public interface ISearchConfiguration
extends java.io.Serializable

COM Interface 'ISearchConfiguration'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriSearch.tlb'

Description: 'Provides access to the search configuration object.' 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 IIDee2df519_39a5_48f6_ab24_be147ebdd4bd
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addServiceName(IAGSServerObjectName pSON)
          Add search service name.
 void deleteServiceName(IAGSServerObjectName pSON)
          Delete search service name.
 void empty()
          Reset to default value and clean service names array.
 void emptyAdvancedOptions()
          Resets the default values of the advanced options page and cleans the array of service names.
 void emptySearchOptions()
          Resets the default values of the search options page.
 int getMaxResultsPerPage()
          The maximum number of search result per page.
 IAGSServerObjectName getServiceName(int index)
          The search service object name at the specified index.
 int getServicesCount()
          The count of search services.
 boolean isCheckSynonymsUserDefined()
          Indicates whether to use custom synonyms.
 boolean isCheckSynonymsWordNet()
          Indicates whether to use the built in WordNet synonyms.
 boolean isServiceSelected(IAGSServerObjectName pSON)
          Indicates whether a service is selected.
 boolean isShowPopup()
          Indicates whether to show pop-up in search result page.
 boolean isZoomToSelectedLocation()
          Indicates whether to zoom to the select text based spatial search location.
 void loadFromFile(java.lang.String path)
          Load configuration settings from the specificed location.
 void saveToFile(java.lang.String path)
          Save configuration settings to the specificed location.
 void setCheckSynonymsUserDefined(boolean pCheckSynonymsUserDefined)
          Indicates whether to use custom synonyms.
 void setCheckSynonymsWordNet(boolean pCheckSynonymsWordNet)
          Indicates whether to use the built in WordNet synonyms.
 void setIsServiceSelected(IAGSServerObjectName pSON, boolean bSelected)
          Indicates whether a service is selected.
 void setMaxResultsPerPage(int pCount)
          The maximum number of search result per page.
 void setShowPopup(boolean pShow)
          Indicates whether to show pop-up in search result page.
 void setZoomToSelectedLocation(boolean pZoomToSelectedLocation)
          Indicates whether to zoom to the select text based spatial search location.
 

Field Detail

IIDee2df519_39a5_48f6_ab24_be147ebdd4bd

static final int IIDee2df519_39a5_48f6_ab24_be147ebdd4bd
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

loadFromFile

void loadFromFile(java.lang.String path)
                  throws java.io.IOException,
                         AutomationException
Load configuration settings from the specificed location.

Parameters:
path - The path (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveToFile

void saveToFile(java.lang.String path)
                throws java.io.IOException,
                       AutomationException
Save configuration settings to the specificed location.

Parameters:
path - The path (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServicesCount

int getServicesCount()
                     throws java.io.IOException,
                            AutomationException
The count of search services.

Returns:
The pCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServiceName

IAGSServerObjectName getServiceName(int index)
                                    throws java.io.IOException,
                                           AutomationException
The search service object name at the specified index.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isServiceSelected

boolean isServiceSelected(IAGSServerObjectName pSON)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether a service is selected.

Parameters:
pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
Returns:
The bSelected
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsServiceSelected

void setIsServiceSelected(IAGSServerObjectName pSON,
                          boolean bSelected)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether a service is selected.

Parameters:
pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
bSelected - The bSelected (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addServiceName

void addServiceName(IAGSServerObjectName pSON)
                    throws java.io.IOException,
                           AutomationException
Add search service name.

Parameters:
pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteServiceName

void deleteServiceName(IAGSServerObjectName pSON)
                       throws java.io.IOException,
                              AutomationException
Delete search service name.

Parameters:
pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws java.io.IOException,
                  AutomationException
Reset to default value and clean service names array.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxResultsPerPage

int getMaxResultsPerPage()
                         throws java.io.IOException,
                                AutomationException
The maximum number of search result per page.

Returns:
The pCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxResultsPerPage

void setMaxResultsPerPage(int pCount)
                          throws java.io.IOException,
                                 AutomationException
The maximum number of search result per page.

Parameters:
pCount - The pCount (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowPopup

boolean isShowPopup()
                    throws java.io.IOException,
                           AutomationException
Indicates whether to show pop-up in search result page.

Returns:
The pShow
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowPopup

void setShowPopup(boolean pShow)
                  throws java.io.IOException,
                         AutomationException
Indicates whether to show pop-up in search result page.

Parameters:
pShow - The pShow (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isZoomToSelectedLocation

boolean isZoomToSelectedLocation()
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether to zoom to the select text based spatial search location.

Returns:
The pZoomToSelectedLocation
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setZoomToSelectedLocation

void setZoomToSelectedLocation(boolean pZoomToSelectedLocation)
                               throws java.io.IOException,
                                      AutomationException
Indicates whether to zoom to the select text based spatial search location.

Parameters:
pZoomToSelectedLocation - The pZoomToSelectedLocation (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsWordNet

boolean isCheckSynonymsWordNet()
                               throws java.io.IOException,
                                      AutomationException
Indicates whether to use the built in WordNet synonyms.

Returns:
The pCheckSynonymsWordNet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsWordNet

void setCheckSynonymsWordNet(boolean pCheckSynonymsWordNet)
                             throws java.io.IOException,
                                    AutomationException
Indicates whether to use the built in WordNet synonyms.

Parameters:
pCheckSynonymsWordNet - The pCheckSynonymsWordNet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsUserDefined

boolean isCheckSynonymsUserDefined()
                                   throws java.io.IOException,
                                          AutomationException
Indicates whether to use custom synonyms.

Returns:
The pCheckSynonymsUserDefined
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsUserDefined

void setCheckSynonymsUserDefined(boolean pCheckSynonymsUserDefined)
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether to use custom synonyms.

Parameters:
pCheckSynonymsUserDefined - The pCheckSynonymsUserDefined (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

emptySearchOptions

void emptySearchOptions()
                        throws java.io.IOException,
                               AutomationException
Resets the default values of the search options page.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

emptyAdvancedOptions

void emptyAdvancedOptions()
                          throws java.io.IOException,
                                 AutomationException
Resets the default values of the advanced options page and cleans the array of service names.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.