com.esri.arcgis.trackinganalyst
Class ActionEnvironment

java.lang.Object
  com.esri.arcgis.trackinganalyst.ActionEnvironment

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IActionLookupSupport, java.io.Externalizable, java.io.Serializable

public class ActionEnvironment
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IActionLookupSupport, IPersistStream, IPersist, ISupportErrorInfo, IDocumentVersionSupportGEN, java.io.Externalizable

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

Description 'Manager of lookup tables and other environmental action properties.' 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

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.trackinganalyst.IActionLookupSupport

IID, IID2c55477c_9b6c_42c2_b453_1b4c1ad59e18, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

ActionEnvironment()
Constructs a ActionEnvironment using ArcGIS Engine.

ActionEnvironment(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionEnvironment theActionEnvironment = (ActionEnvironment) obj;

Method Summary

void	close() Close the Action Environment.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	expandQuery(java.lang.String bstrQuery) Insert lookup table values into query string.
IActionLookupSources	getActionLookupSources() Lookup data sources.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getRefreshRate() RefreshRate for lookup tables.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
IEnumVARIANT	listDataValues(java.lang.String bstrLookupTableName, java.lang.String bstrFieldName, int[] peFieldType) Retrieve list of data values from lookup table.
IEnumBSTR	listFields(java.lang.String bstrLookupTableName) Retrieve list of field names from lookup table.
void	load(IStream pstm) load
void	readDataValues(java.lang.String bstrLookupTableName) Read data values from lookup table.
void	readExternal(java.io.ObjectInput in)
void	register(IActionProcessor actionProcessor) Register an Action Processor.
void	release() Release a ActionEnvironment.
void	save(IStream pstm, int fClearDirty) save
void	setRefreshRate(int pMinutes) RefreshRate for lookup tables.
void	unRegister(IActionProcessor actionProcessor) Unregister an Action Processor.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ActionEnvironment

public ActionEnvironment()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a ActionEnvironment using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ActionEnvironment

public ActionEnvironment(java.lang.Object obj)
                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ActionEnvironment theActionEnvironment = (ActionEnvironment) obj;

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

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 ActionEnvironment.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getActionLookupSources

public IActionLookupSources getActionLookupSources()
                                            throws java.io.IOException,
                                                   AutomationException

Lookup data sources.

Specified by:

getActionLookupSources in interface IActionLookupSupport

Returns:

A reference to a com.esri.arcgis.trackinganalyst.IActionLookupSources

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRefreshRate

public void setRefreshRate(int pMinutes)
                    throws java.io.IOException,
                           AutomationException

RefreshRate for lookup tables.

Specified by:

setRefreshRate in interface IActionLookupSupport

Parameters:

pMinutes - The pMinutes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRefreshRate

public int getRefreshRate()
                   throws java.io.IOException,
                          AutomationException

RefreshRate for lookup tables.

Specified by:

getRefreshRate in interface IActionLookupSupport

Returns:

The pMinutes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readDataValues

public void readDataValues(java.lang.String bstrLookupTableName)
                    throws java.io.IOException,
                           AutomationException

Read data values from lookup table.

Specified by:

readDataValues in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

expandQuery

public java.lang.String expandQuery(java.lang.String bstrQuery)
                             throws java.io.IOException,
                                    AutomationException

Insert lookup table values into query string.

Specified by:

expandQuery in interface IActionLookupSupport

Parameters:

bstrQuery - The bstrQuery (in)

Returns:

The pExpandedQuery

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listDataValues

public IEnumVARIANT listDataValues(java.lang.String bstrLookupTableName,
                                   java.lang.String bstrFieldName,
                                   int[] peFieldType)
                            throws java.io.IOException,
                                   AutomationException

Retrieve list of data values from lookup table.

Specified by:

listDataValues in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

bstrFieldName - The bstrFieldName (in)

peFieldType - A com.esri.arcgis.geodatabase.esriFieldType constant (out: use single element array)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.IEnumVARIANT

Throws:

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

AutomationException - If the ArcObject component throws an exception.

listFields

public IEnumBSTR listFields(java.lang.String bstrLookupTableName)
                     throws java.io.IOException,
                            AutomationException

Retrieve list of field names from lookup table.

Specified by:

listFields in interface IActionLookupSupport

Parameters:

bstrLookupTableName - The bstrLookupTableName (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

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

AutomationException - If the ArcObject component throws an exception.

close

public void close()
           throws java.io.IOException,
                  AutomationException

Close the Action Environment.

Specified by:

close in interface IActionLookupSupport

Throws:

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

AutomationException - If the ArcObject component throws an exception.

register

public void register(IActionProcessor actionProcessor)
              throws java.io.IOException,
                     AutomationException

Register an Action Processor.

Specified by:

register in interface IActionLookupSupport

Parameters:

actionProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unRegister

public void unRegister(IActionProcessor actionProcessor)
                throws java.io.IOException,
                       AutomationException

Unregister an Action Processor.

Specified by:

unRegister in interface IActionLookupSupport

Parameters:

actionProcessor - A reference to a com.esri.arcgis.carto.IActionProcessor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException