com.esri.arcgis.search
Interface ISearchConfiguration

All Superinterfaces:

Serializable

All Known Implementing Classes:

SearchConfiguration

public interface ISearchConfiguration
extends Serializable

Provides access to the search configuration object.

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(String path) Load configuration settings from the specificed location.
void	saveToFile(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.

Method Detail

loadFromFile

void loadFromFile(String path)
                  throws IOException,
                         AutomationException

Load configuration settings from the specificed location.

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveToFile

void saveToFile(String path)
                throws IOException,
                       AutomationException

Save configuration settings to the specificed location.

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServicesCount

int getServicesCount()
                     throws IOException,
                            AutomationException

The count of search services.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceName

IAGSServerObjectName getServiceName(int index)
                                    throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isServiceSelected

boolean isServiceSelected(IAGSServerObjectName pSON)
                          throws IOException,
                                 AutomationException

Indicates whether a service is selected.

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Returns:

The bSelected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsServiceSelected

void setIsServiceSelected(IAGSServerObjectName pSON,
                          boolean bSelected)
                          throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addServiceName

void addServiceName(IAGSServerObjectName pSON)
                    throws IOException,
                           AutomationException

Add search service name.

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteServiceName

void deleteServiceName(IAGSServerObjectName pSON)
                       throws IOException,
                              AutomationException

Delete search service name.

Parameters:

pSON - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws IOException,
                  AutomationException

Reset to default value and clean service names array.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxResultsPerPage

int getMaxResultsPerPage()
                         throws IOException,
                                AutomationException

The maximum number of search result per page.

Returns:

The pCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxResultsPerPage

void setMaxResultsPerPage(int pCount)
                          throws IOException,
                                 AutomationException

The maximum number of search result per page.

Parameters:

pCount - The pCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowPopup

boolean isShowPopup()
                    throws IOException,
                           AutomationException

Indicates whether to show pop-up in search result page.

Returns:

The pShow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowPopup

void setShowPopup(boolean pShow)
                  throws IOException,
                         AutomationException

Indicates whether to show pop-up in search result page.

Parameters:

pShow - The pShow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZoomToSelectedLocation

boolean isZoomToSelectedLocation()
                                 throws IOException,
                                        AutomationException

Indicates whether to zoom to the select text based spatial search location.

Returns:

The pZoomToSelectedLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomToSelectedLocation

void setZoomToSelectedLocation(boolean pZoomToSelectedLocation)
                               throws IOException,
                                      AutomationException

Indicates whether to zoom to the select text based spatial search location.

Parameters:

pZoomToSelectedLocation - The pZoomToSelectedLocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsWordNet

boolean isCheckSynonymsWordNet()
                               throws IOException,
                                      AutomationException

Indicates whether to use the built in WordNet synonyms.

Returns:

The pCheckSynonymsWordNet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsWordNet

void setCheckSynonymsWordNet(boolean pCheckSynonymsWordNet)
                             throws IOException,
                                    AutomationException

Indicates whether to use the built in WordNet synonyms.

Parameters:

pCheckSynonymsWordNet - The pCheckSynonymsWordNet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCheckSynonymsUserDefined

boolean isCheckSynonymsUserDefined()
                                   throws IOException,
                                          AutomationException

Indicates whether to use custom synonyms.

Returns:

The pCheckSynonymsUserDefined

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCheckSynonymsUserDefined

void setCheckSynonymsUserDefined(boolean pCheckSynonymsUserDefined)
                                 throws IOException,
                                        AutomationException

Indicates whether to use custom synonyms.

Parameters:

pCheckSynonymsUserDefined - The pCheckSynonymsUserDefined (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

emptySearchOptions

void emptySearchOptions()
                        throws IOException,
                               AutomationException

Resets the default values of the search options page.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

emptyAdvancedOptions

void emptyAdvancedOptions()
                          throws IOException,
                                 AutomationException

Resets the default values of the advanced options page and cleans the array of service names.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.