Esri Geoportal Server
1.0

com.esri.gpt.catalog.search
Interface ISearchFilterSpatialObj

All Superinterfaces:
ISearchFilter, Serializable
All Known Implementing Classes:
SearchFilterHarvestSpatial, SearchFilterSpatial

public interface ISearchFilterSpatialObj
extends ISearchFilter

The Interface ISearchFilterSpatialObj. Defines methods for a spatial type of search filter.


Nested Class Summary
static class ISearchFilterSpatialObj.OptionsBounds
          Options of what bounds to use for search.
 
Method Summary
 Envelope getEnvelope()
          Gets the envelope.
 String getSelectedBounds()
          Gets the selected bounds options.
 ISearchFilterSpatialObj.OptionsBounds getSelectedBoundsAsEnum()
          Gets the selected bounds options.
 Envelope getVisibleEnvelope()
          Gets the visible envelope.
 void setEnvelope(Envelope envelope)
          Sets the envelope.
 void setSelectedBounds(String selectedBounds)
          Sets the selected bounds options i.e.
 void setSelectedBoundsAsEnum(ISearchFilterSpatialObj.OptionsBounds selectedBounds)
          Sets the selected bounds options i.e.
 void setVisibleEnvelope(Envelope envelope)
          Sets the visible envelope.
 
Methods inherited from interface com.esri.gpt.catalog.search.ISearchFilter
getParams, isEquals, reset, setParams, validate
 

Method Detail

getVisibleEnvelope

Envelope getVisibleEnvelope()
Gets the visible envelope.

Returns:
the visible envelope

setVisibleEnvelope

void setVisibleEnvelope(Envelope envelope)
Sets the visible envelope.

Parameters:
envelope - the envelope

getEnvelope

Envelope getEnvelope()
Gets the envelope.

Returns:
the envelope

setEnvelope

void setEnvelope(Envelope envelope)
Sets the envelope.

Parameters:
envelope - the new envelope

setSelectedBounds

void setSelectedBounds(String selectedBounds)
Sets the selected bounds options i.e. whether data envelopes are contained, anywhere or intersecting.

Parameters:
selectedBounds - the new selected bounds

getSelectedBounds

String getSelectedBounds()
Gets the selected bounds options.

Returns:
the selected bounds

setSelectedBoundsAsEnum

void setSelectedBoundsAsEnum(ISearchFilterSpatialObj.OptionsBounds selectedBounds)
Sets the selected bounds options i.e. whether data envelopes are contained, anywhere or intersecting.

Parameters:
selectedBounds - the new selected bounds

getSelectedBoundsAsEnum

ISearchFilterSpatialObj.OptionsBounds getSelectedBoundsAsEnum()
Gets the selected bounds options.

Returns:
the selected bounds

Esri Geoportal Server
1.0

Copyright 2011 Environmental Systems Research Institute. All rights reserved. Use is subject to license terms.