com.esri.arcgis.trackinganalyst
Class ConditionalActionHelper

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.ConditionalActionHelper
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IConditionalActionConfigure, IConditionalActionSetup, java.io.Serializable

public class ConditionalActionHelper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IConditionalActionConfigure, IConditionalActionSetup

COM Class 'ConditionalActionHelper'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'This class serves as a base tracking action configuration foundation object that can be used to build or aggregate new tracking action configuration dialogs.' 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.IConditionalActionConfigure
DISPID_1_GET_NAME, DISPID_1_PUTREF_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_NAME, DISPID_4_NAME, IID, IID7af27269_e378_4b3e_a385_7691db000fb7, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.IConditionalActionSetup
IID, IID7bcabcd8_8f00_43c5_86a8_16f60a2314dd, xxDummy
 
Constructor Summary
ConditionalActionHelper()
          Constructs a ConditionalActionHelper using ArcGIS Engine.
ConditionalActionHelper(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ConditionalActionHelper theConditionalActionHelper = (ConditionalActionHelper) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 int getActionCategory()
          Get the Actions Category.
 ILayer getActionLayer()
          Get TODO.
 IAction getActionToEdit()
          Action for the control to edit.
static java.lang.String getClsid()
          getClsid.
 IAction getCurrentAction()
          Get The Current Action object that is being edited.
 ILocationTrigger getCurrentLocationTrigger()
          Get TODO.
 java.lang.String getCurrentLocationTriggerName()
          Get TODO.
 ILayer getCurrentTriggerLayer()
          Get TODO.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 ILocationTrigger getLocationTrigger(int nIndex)
          Get TODO.
 int getLocationTriggerCount()
          Get TODO.
 java.lang.String getLocationTriggerDescription(int nIndex)
          Get TODO.
 java.lang.String getLocationTriggerName(int nIndex)
          Get TODO.
 int getLocationTriggerType()
          Get TODO.
 IName getPolygonSourceName()
          Get TODO.
 java.lang.String getPolygonSourceNameText()
          Get TODO.
 java.lang.String getQueryString()
          Get TODO.
 IServerConnection getServerConnection()
          Get the server interface if applicable.
 int getServerGeoType()
          Get TODO.
 ILayer getTriggerLayer(int nIndex)
          Get TODO.
 int getTriggerLayerCount()
          Get TODO.
 java.lang.String getTriggerLayerName(int nIndex)
          Get TODO.
 int getTriggerType()
          Get the Actions Trigger Type.
 int hashCode()
          the hashcode for this object
 boolean isNegateLocationTrigger()
          Get whether or not to negate the location trigger test results.
 boolean isReadOnly()
          Indicates if the action properties are read-only.
 void release()
          Release a ConditionalActionHelper.
 void setActionCategory(int pActionCategory)
          Get the Actions Category.
 void setActionLayerByRef(ILayer ippActionLayer)
          Get TODO.
 void setActionToEditByRef(IAction pVal)
          Action for the control to edit.
 void setCurrentLocationTriggerNameAndDesc(java.lang.String bstrCustomLocationTriggerName, java.lang.String bstrCustomLocationTriggerDesc)
          Get TODO.
 void setCurrentTriggerLayerByRef(ILayer ippTriggerLayer)
          Get TODO.
 void setLocationTriggerType(int pLocationTriggerType)
          Get TODO.
 void setNegateLocationTrigger(boolean pNegateLocationTrigger)
          Get whether or not to negate the location trigger test results.
 void setPolygonSourceNameByRef(IName ippPolygonSourceName)
          Get TODO.
 void setQueryString(java.lang.String pbstrQueryString)
          Get TODO.
 void setReadOnly(boolean pbvalReadOnly)
          Indicates if the action properties are read-only.
 void setServerConnection(IServerConnection piServerConnection)
          Set the active server connection, if running in a tracking server environment or service environment in a client application.
 void setServerGeoType(int peServerGeoType)
          Get TODO.
 void setTriggerType(int pTriggerType)
          Get the Actions Trigger Type.
 void updateAction()
          Update the Action component with the values in the activeX component.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConditionalActionHelper

public ConditionalActionHelper()
                        throws java.io.IOException,
                               java.net.UnknownHostException
Constructs a ConditionalActionHelper using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

ConditionalActionHelper

public ConditionalActionHelper(java.lang.Object obj)
                        throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ConditionalActionHelper theConditionalActionHelper = (ConditionalActionHelper) obj;

Construct a ConditionalActionHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ConditionalActionHelper.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a ConditionalActionHelper.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getActionToEdit

public IAction getActionToEdit()
                        throws java.io.IOException,
                               AutomationException
Action for the control to edit.

Specified by:
getActionToEdit in interface IConditionalActionConfigure
Returns:
A reference to a com.esri.arcgis.carto.IAction
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionToEditByRef

public void setActionToEditByRef(IAction pVal)
                          throws java.io.IOException,
                                 AutomationException
Action for the control to edit.

Specified by:
setActionToEditByRef in interface IConditionalActionConfigure
Parameters:
pVal - A reference to a com.esri.arcgis.carto.IAction (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly()
                   throws java.io.IOException,
                          AutomationException
Indicates if the action properties are read-only.

Specified by:
isReadOnly in interface IConditionalActionConfigure
Returns:
The pbvalReadOnly
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReadOnly

public void setReadOnly(boolean pbvalReadOnly)
                 throws java.io.IOException,
                        AutomationException
Indicates if the action properties are read-only.

Specified by:
setReadOnly in interface IConditionalActionConfigure
Parameters:
pbvalReadOnly - The pbvalReadOnly (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateAction

public void updateAction()
                  throws java.io.IOException,
                         AutomationException
Update the Action component with the values in the activeX component.

Specified by:
updateAction in interface IConditionalActionConfigure
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServerConnection

public void setServerConnection(IServerConnection piServerConnection)
                         throws java.io.IOException,
                                AutomationException
Set the active server connection, if running in a tracking server environment or service environment in a client application.

Specified by:
setServerConnection in interface IConditionalActionConfigure
Parameters:
piServerConnection - A reference to a com.esri.arcgis.trackinganalyst.IServerConnection (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTriggerType

public void setTriggerType(int pTriggerType)
                    throws java.io.IOException,
                           AutomationException
Get the Actions Trigger Type.

Specified by:
setTriggerType in interface IConditionalActionSetup
Parameters:
pTriggerType - A com.esri.arcgis.carto.enumTriggerType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerType

public int getTriggerType()
                   throws java.io.IOException,
                          AutomationException
Get the Actions Trigger Type.

Specified by:
getTriggerType in interface IConditionalActionSetup
Returns:
A com.esri.arcgis.carto.enumTriggerType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocationTriggerType

public void setLocationTriggerType(int pLocationTriggerType)
                            throws java.io.IOException,
                                   AutomationException
Get TODO.

Specified by:
setLocationTriggerType in interface IConditionalActionSetup
Parameters:
pLocationTriggerType - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTriggerType

public int getLocationTriggerType()
                           throws java.io.IOException,
                                  AutomationException
Get TODO.

Specified by:
getLocationTriggerType in interface IConditionalActionSetup
Returns:
A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActionCategory

public int getActionCategory()
                      throws java.io.IOException,
                             AutomationException
Get the Actions Category.

Specified by:
getActionCategory in interface IConditionalActionSetup
Returns:
A com.esri.arcgis.carto.enumActionCategory constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionCategory

public void setActionCategory(int pActionCategory)
                       throws java.io.IOException,
                              AutomationException
Get the Actions Category.

Specified by:
setActionCategory in interface IConditionalActionSetup
Parameters:
pActionCategory - A com.esri.arcgis.carto.enumActionCategory constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setServerGeoType

public void setServerGeoType(int peServerGeoType)
                      throws java.io.IOException,
                             AutomationException
Get TODO.

Specified by:
setServerGeoType in interface IConditionalActionSetup
Parameters:
peServerGeoType - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerGeoType

public int getServerGeoType()
                     throws java.io.IOException,
                            AutomationException
Get TODO.

Specified by:
getServerGeoType in interface IConditionalActionSetup
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isNegateLocationTrigger

public boolean isNegateLocationTrigger()
                                throws java.io.IOException,
                                       AutomationException
Get whether or not to negate the location trigger test results.

Specified by:
isNegateLocationTrigger in interface IConditionalActionSetup
Returns:
The pNegateLocationTrigger
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNegateLocationTrigger

public void setNegateLocationTrigger(boolean pNegateLocationTrigger)
                              throws java.io.IOException,
                                     AutomationException
Get whether or not to negate the location trigger test results.

Specified by:
setNegateLocationTrigger in interface IConditionalActionSetup
Parameters:
pNegateLocationTrigger - The pNegateLocationTrigger (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerConnection

public IServerConnection getServerConnection()
                                      throws java.io.IOException,
                                             AutomationException
Get the server interface if applicable.

Specified by:
getServerConnection in interface IConditionalActionSetup
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IServerConnection
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentLocationTrigger

public ILocationTrigger getCurrentLocationTrigger()
                                           throws java.io.IOException,
                                                  AutomationException
Get TODO.

Specified by:
getCurrentLocationTrigger in interface IConditionalActionSetup
Returns:
A reference to a com.esri.arcgis.carto.ILocationTrigger
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentLocationTriggerName

public java.lang.String getCurrentLocationTriggerName()
                                               throws java.io.IOException,
                                                      AutomationException
Get TODO.

Specified by:
getCurrentLocationTriggerName in interface IConditionalActionSetup
Returns:
The pbstrCustomLocationTriggerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentLocationTriggerNameAndDesc

public void setCurrentLocationTriggerNameAndDesc(java.lang.String bstrCustomLocationTriggerName,
                                                 java.lang.String bstrCustomLocationTriggerDesc)
                                          throws java.io.IOException,
                                                 AutomationException
Get TODO.

Specified by:
setCurrentLocationTriggerNameAndDesc in interface IConditionalActionSetup
Parameters:
bstrCustomLocationTriggerName - The bstrCustomLocationTriggerName (in)
bstrCustomLocationTriggerDesc - The bstrCustomLocationTriggerDesc (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActionLayer

public ILayer getActionLayer()
                      throws java.io.IOException,
                             AutomationException
Get TODO.

Specified by:
getActionLayer in interface IConditionalActionSetup
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActionLayerByRef

public void setActionLayerByRef(ILayer ippActionLayer)
                         throws java.io.IOException,
                                AutomationException
Get TODO.

Specified by:
setActionLayerByRef in interface IConditionalActionSetup
Parameters:
ippActionLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryString

public java.lang.String getQueryString()
                                throws java.io.IOException,
                                       AutomationException
Get TODO.

Specified by:
getQueryString in interface IConditionalActionSetup
Returns:
The pbstrQueryString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryString

public void setQueryString(java.lang.String pbstrQueryString)
                    throws java.io.IOException,
                           AutomationException
Get TODO.

Specified by:
setQueryString in interface IConditionalActionSetup
Parameters:
pbstrQueryString - The pbstrQueryString (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonSourceName

public IName getPolygonSourceName()
                           throws java.io.IOException,
                                  AutomationException
Get TODO.

Specified by:
getPolygonSourceName in interface IConditionalActionSetup
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygonSourceNameByRef

public void setPolygonSourceNameByRef(IName ippPolygonSourceName)
                               throws java.io.IOException,
                                      AutomationException
Get TODO.

Specified by:
setPolygonSourceNameByRef in interface IConditionalActionSetup
Parameters:
ippPolygonSourceName - A reference to a com.esri.arcgis.system.IName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentTriggerLayer

public ILayer getCurrentTriggerLayer()
                              throws java.io.IOException,
                                     AutomationException
Get TODO.

Specified by:
getCurrentTriggerLayer in interface IConditionalActionSetup
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentTriggerLayerByRef

public void setCurrentTriggerLayerByRef(ILayer ippTriggerLayer)
                                 throws java.io.IOException,
                                        AutomationException
Get TODO.

Specified by:
setCurrentTriggerLayerByRef in interface IConditionalActionSetup
Parameters:
ippTriggerLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygonSourceNameText

public java.lang.String getPolygonSourceNameText()
                                          throws java.io.IOException,
                                                 AutomationException
Get TODO.

Specified by:
getPolygonSourceNameText in interface IConditionalActionSetup
Returns:
The pbstrPolygonSourceNameText
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerLayerCount

public int getTriggerLayerCount()
                         throws java.io.IOException,
                                AutomationException
Get TODO.

Specified by:
getTriggerLayerCount in interface IConditionalActionSetup
Returns:
The nCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerLayer

public ILayer getTriggerLayer(int nIndex)
                       throws java.io.IOException,
                              AutomationException
Get TODO.

Specified by:
getTriggerLayer in interface IConditionalActionSetup
Parameters:
nIndex - The nIndex (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTriggerLayerName

public java.lang.String getTriggerLayerName(int nIndex)
                                     throws java.io.IOException,
                                            AutomationException
Get TODO.

Specified by:
getTriggerLayerName in interface IConditionalActionSetup
Parameters:
nIndex - The nIndex (in)
Returns:
The bstrTriggerLayerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTriggerCount

public int getLocationTriggerCount()
                            throws java.io.IOException,
                                   AutomationException
Get TODO.

Specified by:
getLocationTriggerCount in interface IConditionalActionSetup
Returns:
The nCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTrigger

public ILocationTrigger getLocationTrigger(int nIndex)
                                    throws java.io.IOException,
                                           AutomationException
Get TODO.

Specified by:
getLocationTrigger in interface IConditionalActionSetup
Parameters:
nIndex - The nIndex (in)
Returns:
A reference to a com.esri.arcgis.carto.ILocationTrigger
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTriggerName

public java.lang.String getLocationTriggerName(int nIndex)
                                        throws java.io.IOException,
                                               AutomationException
Get TODO.

Specified by:
getLocationTriggerName in interface IConditionalActionSetup
Parameters:
nIndex - The nIndex (in)
Returns:
The bstrLocationTriggerName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocationTriggerDescription

public java.lang.String getLocationTriggerDescription(int nIndex)
                                               throws java.io.IOException,
                                                      AutomationException
Get TODO.

Specified by:
getLocationTriggerDescription in interface IConditionalActionSetup
Parameters:
nIndex - The nIndex (in)
Returns:
The bstrLocationTriggerDesc
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentAction

public IAction getCurrentAction()
                         throws java.io.IOException,
                                AutomationException
Get The Current Action object that is being edited.

Specified by:
getCurrentAction in interface IConditionalActionSetup
Returns:
A reference to a com.esri.arcgis.carto.IAction
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.