com.esri.arcgis.carto
Class GraphicFeatureServer

java.lang.Object
  com.esri.arcgis.carto.GraphicFeatureServer

All Implemented Interfaces:

IGraphicFeatureServer, IGraphicFeatureServer2, IGraphicFeatureServerInit, IGraphicFeatureServerReplication, com.esri.arcgis.interop.RemoteObjRef, IServerObjectExtension, ILogSupport, IObjectActivate, IObjectConstruct, IRequestHandler, IRequestHandler2, IRESTRequestHandler, ISupportErrorInfo, java.io.Serializable

public class GraphicFeatureServer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IServerObjectExtension, IObjectConstruct, IRequestHandler, IRequestHandler2, IObjectActivate, IGraphicFeatureServer, IGraphicFeatureServer2, IGraphicFeatureServerInit, IGraphicFeatureServerReplication, ILogSupport, IRESTRequestHandler, ISupportErrorInfo

COM Class 'GraphicFeatureServer'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'The Graphic Feature Server component provides programmatic access to the Graphic Features.' 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.system.IRequestHandler2

IID, IID8319e7d0_8ad1_48ed_aa99_03f9d0c93ba8, xxDummy

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

IID46a0e2ea_3b64_4a46_bd78_88a1660f35bb

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

IID, IIDe3b78022_143e_4e61_9099_ed319ec061e7, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicFeatureServer

IID, IID3df5bcfd_5945_4dd6_bdd1_5c3357b8209c, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicFeatureServer2

IID, IID389f4fa0_628d_403d_9015_62857cb1c05e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicFeatureServerInit

IID, IID6790d29a_7ec2_4f84_bccf_2b86e92491da, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IGraphicFeatureServerReplication

IID, IID6a727d6f_0b7d_478e_847e_8cf875180b0d, xxDummy

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

IID, IID9d66a418_d54a_48ed_88bd_043a25fa9c83, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

GraphicFeatureServer()
Constructs a GraphicFeatureServer using ArcGIS Engine.

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

Method Summary

void	activate() Activates the object.
IEditResults	add(int layerOrTableID, IDataObjects dataObjects) add
IEditResults	add2(java.lang.String gdbVersion, int layerOrTableID, IDataObjects dataObjects, boolean rollbackOnFailure) add2
IEditResults	addAttachments(int layerOrTableID, IAttachmentDataArray attachmentDataArray) addAttachments
IEditResults	addAttachments2(java.lang.String gdbVersion, int layerOrTableID, IAttachmentDataArray attachmentDataArray, boolean rollbackOnFailure) addAttachments2
void	alterReplica(IGPReplica replica) Alter the definition of a replica.
ITableEditResults	applyEdits(ITableEdits tableEdits) applyEdits
ITableEditResults	applyEdits2(java.lang.String gdbVersion, ITableEdits tableEdits, boolean rollbackOnFailure) applyEdits2
void	connect(IMapServer mapServer) Initialize GraphicFeatureServer object with MapServer.
void	construct(IPropertySet props) Two phase object construction.
IGDSData	createReplica(java.lang.String replicaName, IGFSReplicaDescription replicaDescription, IGPReplicaOptions repOptions, IGDSExportOptions exportOptions, int transportType) Create Replica.
void	deactivate() Deactivates the object.
void	delete(int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter) delete
void	delete2(java.lang.String gdbVersion, int layerOrTableID, java.lang.String definitionExpression, boolean rollbackOnFailure, IQueryFilter queryFilter) delete2
IEditResults	deleteAttachments(int layerOrTableID, ILongArray idsOfAttachmentsToDelete) deleteAttachments
IEditResults	deleteAttachments2(java.lang.String gdbVersion, int layerOrTableID, ILongArray idsOfAttachmentsToDelete, boolean rollbackOnFailure) deleteAttachments2
IEditResults	deleteByID(int layerOrTableID, ILongArray idsOfObjectsToDelete) deleteByID
IEditResults	deleteByID2(java.lang.String gdbVersion, int layerOrTableID, ILongArray idsOfObjectsToDelete, boolean rollbackOnFailure) deleteByID2
boolean	equals(java.lang.Object o) Compare this object with another
IGDSData	exportReplicaDataChanges(java.lang.String replicaName, IGDSExportOptions options, int transportType) Exports data changes for a replica.
static java.lang.String	getClsid() getClsid.
int	getCount(int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter) getCount
int	getCount2(java.lang.String gdbVersion, int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter) getCount2
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IGraphicFeatureLayers	getLayers(IServerSymbolOutputOptions symbolOutputOptions) Yields layers.
IGPReplicas	getReplicas() The replicas in the workspace of the mxd document's data source.
java.lang.String	getSchema() This method returns the resource hierarchy of a REST based SOE.
IFeatureServerInfo	getServerInfo() getServerInfo
int	getServiceObjectCount(IGFSTableDescriptions layerOrTableDescriptions, IGeometry geometry) getServiceObjectCount
int	getServiceObjectCount2(java.lang.String gdbVersion, IGFSTableDescriptions layerOrTableDescriptions, IGeometry geometry) getServiceObjectCount2
IDataObjectTables	getTables(IServerSymbolOutputOptions symbolOutputOptions, boolean ignoreLayers) Yields tables/layers.
double	getZDefaults() getZDefaults
byte[]	handleBinaryRequest(byte[] request) Handles a binary request.
byte[]	handleBinaryRequest2(java.lang.String capabilities, byte[] request) Handles a binary request with explicit capabilities.
byte[]	handleRESTRequest(java.lang.String capabilities, java.lang.String resourceName, java.lang.String operationName, java.lang.String operationInput, java.lang.String outputFormat, java.lang.String requestProperties, java.lang.String[] responseProperties) Handles REST requests for SOE.
java.lang.String	handleStringRequest(java.lang.String capabilities, java.lang.String request) Handles a SOAP string request.
int	hashCode() the hashcode for this object
boolean	importReplicaDataChanges(int sourceType, int reconcilePolicy, IGDSData data) Import the data changes for a replica.
void	init(IServerObjectHelper pSOH) Initializes and starts the server object specified by the IServerObjectHelper reference.
void	initLogging(ILog log) Initializes an object with a log.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isEnableZDefaults() isEnableZDefaults
IServiceData	query(int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter, IServiceDataOptions serviceDataOptions) query
IServiceData	query2(java.lang.String gdbVersion, int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter, double maximumAllowableOffset, IServiceDataOptions serviceDataOptions) query2
IAttachmentDataArray	queryAttachmentData(int layerOrTableID, ILongArray attachmentIDs, int transportType) queryAttachmentData
IAttachmentDataArray	queryAttachmentData2(java.lang.String gdbVersion, int layerOrTableID, ILongArray attachmentIDs, int transportType) queryAttachmentData2
IAttachmentInfoArray	queryAttachmentInfos(int layerOrTableID, ILongArray objectIDs) queryAttachmentInfos
IAttachmentInfoArray	queryAttachmentInfos2(java.lang.String gdbVersion, int layerOrTableID, ILongArray objectIDs) queryAttachmentInfos2
IServiceData	queryFromService(IGFSTableDescriptions layerOrTableDescriptions, IGeometry geometry, ISpatialReference outSR, ITimeReference outTR, IServiceDataOptions serviceDataOptions) queryFromService
IServiceData	queryFromService2(java.lang.String gdbVersion, IGFSTableDescriptions layerOrTableDescriptions, IGeometry geometry, ISpatialReference outSR, ITimeReference outTR, double maximumAllowableOffset, IServiceDataOptions serviceDataOptions) queryFromService2
IStringArray	queryHTMLPopups(int layerOrTableID, ILongArray objectIDs) Returns the html as text that can be used in popups.
IStringArray	queryHTMLPopups2(java.lang.String gdbVersion, int layerOrTableID, ILongArray objectIDs) Returns the html as text that can be used in popups.
ILongArray	queryIDs(int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter) queryIDs
ILongArray	queryIDs2(java.lang.String gdbVersion, int layerOrTableID, java.lang.String definitionExpression, IQueryFilter queryFilter) queryIDs2
IServiceData	queryRelatedObjects(int sourceLayerOrTableID, ILongArray objectIDsInSource, int relationshipID, java.lang.String targetDefinitionExpression, java.lang.String targetTableProps, boolean groupBySourceOIDs, ISpatialReference outSR, ITimeReference outTR, IServiceDataOptions serviceDataOptions) queryRelatedObjects
IServiceData	queryRelatedObjects2(java.lang.String gdbVersion, int sourceLayerOrTableID, ILongArray objectIDsInSource, int relationshipID, java.lang.String targetDefinitionExpression, java.lang.String targetTableProps, boolean groupBySourceOIDs, ISpatialReference outSR, ITimeReference outTR, double maximumAllowableOffset, IServiceDataOptions serviceDataOptions) queryRelatedObjects2
void	release() Release a GraphicFeatureServer.
void	setEnableZDefaults(boolean enableZDefaults) setEnableZDefaults
void	setZDefaults(double zDefaults) setZDefaults
void	shutdown() Stops the server object specified by the IServerObjectHelper reference.
void	unregisterReplica(java.lang.String replicaName) Unregister the replica.
IEditResults	update(int layerOrTableID, IDataObjects dataObjects) Updates dataobjects.
IEditResults	update2(java.lang.String gdbVersion, int layerOrTableID, IDataObjects dataObjects, boolean rollbackOnFailure) Updates dataobjects.
IEditResults	updateAttachments(int layerOrTableID, IAttachmentDataArray attachmentDataArray) Updates Attachments.
IEditResults	updateAttachments2(java.lang.String gdbVersion, int layerOrTableID, IAttachmentDataArray attachmentDataArray, boolean rollbackOnFailure) Updates Attachments.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicFeatureServer

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

Constructs a GraphicFeatureServer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GraphicFeatureServer

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

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

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

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

Specified by:

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

init

public void init(IServerObjectHelper pSOH)
          throws java.io.IOException,
                 AutomationException

Initializes and starts the server object specified by the IServerObjectHelper reference.

Product Availability

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

Specified by:

init in interface IServerObjectExtension

Parameters:

pSOH - A reference to a com.esri.arcgis.server.IServerObjectHelper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

shutdown

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

Stops the server object specified by the IServerObjectHelper reference.

Product Availability

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

Specified by:

shutdown in interface IServerObjectExtension

Throws:

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

AutomationException - If the ArcObject component throws an exception.

construct

public void construct(IPropertySet props)
               throws java.io.IOException,
                      AutomationException

Two phase object construction.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

construct in interface IObjectConstruct

Parameters:

props - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest

public byte[] handleBinaryRequest(byte[] request)
                           throws java.io.IOException,
                                  AutomationException

Handles a binary request.

Specified by:

handleBinaryRequest in interface IRequestHandler

Parameters:

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleStringRequest

public java.lang.String handleStringRequest(java.lang.String capabilities,
                                            java.lang.String request)
                                     throws java.io.IOException,
                                            AutomationException

Handles a SOAP string request.

Specified by:

handleStringRequest in interface IRequestHandler

Parameters:

capabilities - The capabilities (in)

request - The request (in)

Returns:

The response

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleBinaryRequest2

public byte[] handleBinaryRequest2(java.lang.String capabilities,
                                   byte[] request)
                            throws java.io.IOException,
                                   AutomationException

Handles a binary request with explicit capabilities.

Specified by:

handleBinaryRequest2 in interface IRequestHandler2

Parameters:

capabilities - The capabilities (in)

request - An unsigned byte (in)

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

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

Activates the object.

Specified by:

activate in interface IObjectActivate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deactivate

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

Deactivates the object.

Specified by:

deactivate in interface IObjectActivate

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public IEditResults add(int layerOrTableID,
                        IDataObjects dataObjects)
                 throws java.io.IOException,
                        AutomationException

add

Specified by:

add in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

dataObjects - A reference to a com.esri.arcgis.carto.IDataObjects (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addAttachments

public IEditResults addAttachments(int layerOrTableID,
                                   IAttachmentDataArray attachmentDataArray)
                            throws java.io.IOException,
                                   AutomationException

addAttachments

Specified by:

addAttachments in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

attachmentDataArray - A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyEdits

public ITableEditResults applyEdits(ITableEdits tableEdits)
                             throws java.io.IOException,
                                    AutomationException

applyEdits

Specified by:

applyEdits in interface IGraphicFeatureServer

Parameters:

tableEdits - A reference to a com.esri.arcgis.carto.ITableEdits (in)

Returns:

A reference to a com.esri.arcgis.carto.ITableEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

public void delete(int layerOrTableID,
                   java.lang.String definitionExpression,
                   IQueryFilter queryFilter)
            throws java.io.IOException,
                   AutomationException

delete

Specified by:

delete in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteAttachments

public IEditResults deleteAttachments(int layerOrTableID,
                                      ILongArray idsOfAttachmentsToDelete)
                               throws java.io.IOException,
                                      AutomationException

deleteAttachments

Specified by:

deleteAttachments in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

idsOfAttachmentsToDelete - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteByID

public IEditResults deleteByID(int layerOrTableID,
                               ILongArray idsOfObjectsToDelete)
                        throws java.io.IOException,
                               AutomationException

deleteByID

Specified by:

deleteByID in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

idsOfObjectsToDelete - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount(int layerOrTableID,
                    java.lang.String definitionExpression,
                    IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException

getCount

Specified by:

getCount in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The numObjects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayers

public IGraphicFeatureLayers getLayers(IServerSymbolOutputOptions symbolOutputOptions)
                                throws java.io.IOException,
                                       AutomationException

Yields layers.

Specified by:

getLayers in interface IGraphicFeatureServer

Parameters:

symbolOutputOptions - A reference to a com.esri.arcgis.carto.IServerSymbolOutputOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IGraphicFeatureLayers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceObjectCount

public int getServiceObjectCount(IGFSTableDescriptions layerOrTableDescriptions,
                                 IGeometry geometry)
                          throws java.io.IOException,
                                 AutomationException

getServiceObjectCount

Specified by:

getServiceObjectCount in interface IGraphicFeatureServer

Parameters:

layerOrTableDescriptions - A reference to a com.esri.arcgis.carto.IGFSTableDescriptions (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The numObjects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTables

public IDataObjectTables getTables(IServerSymbolOutputOptions symbolOutputOptions,
                                   boolean ignoreLayers)
                            throws java.io.IOException,
                                   AutomationException

Yields tables/layers.

Specified by:

getTables in interface IGraphicFeatureServer

Parameters:

symbolOutputOptions - A reference to a com.esri.arcgis.carto.IServerSymbolOutputOptions (in)

ignoreLayers - The ignoreLayers (in)

Returns:

A reference to a com.esri.arcgis.carto.IDataObjectTables

Throws:

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

AutomationException - If the ArcObject component throws an exception.

query

public IServiceData query(int layerOrTableID,
                          java.lang.String definitionExpression,
                          IQueryFilter queryFilter,
                          IServiceDataOptions serviceDataOptions)
                   throws java.io.IOException,
                          AutomationException

query

Specified by:

query in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

serviceDataOptions - A reference to a com.esri.arcgis.carto.IServiceDataOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IServiceData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAttachmentData

public IAttachmentDataArray queryAttachmentData(int layerOrTableID,
                                                ILongArray attachmentIDs,
                                                int transportType)
                                         throws java.io.IOException,
                                                AutomationException

queryAttachmentData

Specified by:

queryAttachmentData in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

attachmentIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

transportType - A com.esri.arcgis.system.esriTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAttachmentInfos

public IAttachmentInfoArray queryAttachmentInfos(int layerOrTableID,
                                                 ILongArray objectIDs)
                                          throws java.io.IOException,
                                                 AutomationException

queryAttachmentInfos

Specified by:

queryAttachmentInfos in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

objectIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IAttachmentInfoArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryFromService

public IServiceData queryFromService(IGFSTableDescriptions layerOrTableDescriptions,
                                     IGeometry geometry,
                                     ISpatialReference outSR,
                                     ITimeReference outTR,
                                     IServiceDataOptions serviceDataOptions)
                              throws java.io.IOException,
                                     AutomationException

queryFromService

Specified by:

queryFromService in interface IGraphicFeatureServer

Parameters:

layerOrTableDescriptions - A reference to a com.esri.arcgis.carto.IGFSTableDescriptions (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

outSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

outTR - A reference to a com.esri.arcgis.system.ITimeReference (in)

serviceDataOptions - A reference to a com.esri.arcgis.carto.IServiceDataOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IServiceData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryIDs

public ILongArray queryIDs(int layerOrTableID,
                           java.lang.String definitionExpression,
                           IQueryFilter queryFilter)
                    throws java.io.IOException,
                           AutomationException

queryIDs

Specified by:

queryIDs in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryHTMLPopups

public IStringArray queryHTMLPopups(int layerOrTableID,
                                    ILongArray objectIDs)
                             throws java.io.IOException,
                                    AutomationException

Returns the html as text that can be used in popups.

Specified by:

queryHTMLPopups in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

objectIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryRelatedObjects

public IServiceData queryRelatedObjects(int sourceLayerOrTableID,
                                        ILongArray objectIDsInSource,
                                        int relationshipID,
                                        java.lang.String targetDefinitionExpression,
                                        java.lang.String targetTableProps,
                                        boolean groupBySourceOIDs,
                                        ISpatialReference outSR,
                                        ITimeReference outTR,
                                        IServiceDataOptions serviceDataOptions)
                                 throws java.io.IOException,
                                        AutomationException

queryRelatedObjects

Specified by:

queryRelatedObjects in interface IGraphicFeatureServer

Parameters:

sourceLayerOrTableID - The sourceLayerOrTableID (in)

objectIDsInSource - A reference to a com.esri.arcgis.system.ILongArray (in)

relationshipID - The relationshipID (in)

targetDefinitionExpression - The targetDefinitionExpression (in)

targetTableProps - The targetTableProps (in)

groupBySourceOIDs - The groupBySourceOIDs (in)

outSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

outTR - A reference to a com.esri.arcgis.system.ITimeReference (in)

serviceDataOptions - A reference to a com.esri.arcgis.carto.IServiceDataOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IServiceData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public IEditResults update(int layerOrTableID,
                           IDataObjects dataObjects)
                    throws java.io.IOException,
                           AutomationException

Updates dataobjects.

Specified by:

update in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

dataObjects - A reference to a com.esri.arcgis.carto.IDataObjects (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateAttachments

public IEditResults updateAttachments(int layerOrTableID,
                                      IAttachmentDataArray attachmentDataArray)
                               throws java.io.IOException,
                                      AutomationException

Updates Attachments.

Specified by:

updateAttachments in interface IGraphicFeatureServer

Parameters:

layerOrTableID - The layerOrTableID (in)

attachmentDataArray - A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add2

public IEditResults add2(java.lang.String gdbVersion,
                         int layerOrTableID,
                         IDataObjects dataObjects,
                         boolean rollbackOnFailure)
                  throws java.io.IOException,
                         AutomationException

add2

Specified by:

add2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

dataObjects - A reference to a com.esri.arcgis.carto.IDataObjects (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addAttachments2

public IEditResults addAttachments2(java.lang.String gdbVersion,
                                    int layerOrTableID,
                                    IAttachmentDataArray attachmentDataArray,
                                    boolean rollbackOnFailure)
                             throws java.io.IOException,
                                    AutomationException

addAttachments2

Specified by:

addAttachments2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

attachmentDataArray - A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applyEdits2

public ITableEditResults applyEdits2(java.lang.String gdbVersion,
                                     ITableEdits tableEdits,
                                     boolean rollbackOnFailure)
                              throws java.io.IOException,
                                     AutomationException

applyEdits2

Specified by:

applyEdits2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

tableEdits - A reference to a com.esri.arcgis.carto.ITableEdits (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.ITableEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete2

public void delete2(java.lang.String gdbVersion,
                    int layerOrTableID,
                    java.lang.String definitionExpression,
                    boolean rollbackOnFailure,
                    IQueryFilter queryFilter)
             throws java.io.IOException,
                    AutomationException

delete2

Specified by:

delete2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

rollbackOnFailure - The rollbackOnFailure (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteAttachments2

public IEditResults deleteAttachments2(java.lang.String gdbVersion,
                                       int layerOrTableID,
                                       ILongArray idsOfAttachmentsToDelete,
                                       boolean rollbackOnFailure)
                                throws java.io.IOException,
                                       AutomationException

deleteAttachments2

Specified by:

deleteAttachments2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

idsOfAttachmentsToDelete - A reference to a com.esri.arcgis.system.ILongArray (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteByID2

public IEditResults deleteByID2(java.lang.String gdbVersion,
                                int layerOrTableID,
                                ILongArray idsOfObjectsToDelete,
                                boolean rollbackOnFailure)
                         throws java.io.IOException,
                                AutomationException

deleteByID2

Specified by:

deleteByID2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

idsOfObjectsToDelete - A reference to a com.esri.arcgis.system.ILongArray (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount2

public int getCount2(java.lang.String gdbVersion,
                     int layerOrTableID,
                     java.lang.String definitionExpression,
                     IQueryFilter queryFilter)
              throws java.io.IOException,
                     AutomationException

getCount2

Specified by:

getCount2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

The numObjects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServerInfo

public IFeatureServerInfo getServerInfo()
                                 throws java.io.IOException,
                                        AutomationException

getServerInfo

Specified by:

getServerInfo in interface IGraphicFeatureServer2

Returns:

A reference to a com.esri.arcgis.carto.IFeatureServerInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getServiceObjectCount2

public int getServiceObjectCount2(java.lang.String gdbVersion,
                                  IGFSTableDescriptions layerOrTableDescriptions,
                                  IGeometry geometry)
                           throws java.io.IOException,
                                  AutomationException

getServiceObjectCount2

Specified by:

getServiceObjectCount2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableDescriptions - A reference to a com.esri.arcgis.carto.IGFSTableDescriptions (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

The numObjects

Throws:

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

AutomationException - If the ArcObject component throws an exception.

query2

public IServiceData query2(java.lang.String gdbVersion,
                           int layerOrTableID,
                           java.lang.String definitionExpression,
                           IQueryFilter queryFilter,
                           double maximumAllowableOffset,
                           IServiceDataOptions serviceDataOptions)
                    throws java.io.IOException,
                           AutomationException

query2

Specified by:

query2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

maximumAllowableOffset - The maximumAllowableOffset (in)

serviceDataOptions - A reference to a com.esri.arcgis.carto.IServiceDataOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IServiceData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAttachmentData2

public IAttachmentDataArray queryAttachmentData2(java.lang.String gdbVersion,
                                                 int layerOrTableID,
                                                 ILongArray attachmentIDs,
                                                 int transportType)
                                          throws java.io.IOException,
                                                 AutomationException

queryAttachmentData2

Specified by:

queryAttachmentData2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

attachmentIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

transportType - A com.esri.arcgis.system.esriTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAttachmentInfos2

public IAttachmentInfoArray queryAttachmentInfos2(java.lang.String gdbVersion,
                                                  int layerOrTableID,
                                                  ILongArray objectIDs)
                                           throws java.io.IOException,
                                                  AutomationException

queryAttachmentInfos2

Specified by:

queryAttachmentInfos2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

objectIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IAttachmentInfoArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryFromService2

public IServiceData queryFromService2(java.lang.String gdbVersion,
                                      IGFSTableDescriptions layerOrTableDescriptions,
                                      IGeometry geometry,
                                      ISpatialReference outSR,
                                      ITimeReference outTR,
                                      double maximumAllowableOffset,
                                      IServiceDataOptions serviceDataOptions)
                               throws java.io.IOException,
                                      AutomationException

queryFromService2

Specified by:

queryFromService2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableDescriptions - A reference to a com.esri.arcgis.carto.IGFSTableDescriptions (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

outSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

outTR - A reference to a com.esri.arcgis.system.ITimeReference (in)

maximumAllowableOffset - The maximumAllowableOffset (in)

serviceDataOptions - A reference to a com.esri.arcgis.carto.IServiceDataOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IServiceData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryIDs2

public ILongArray queryIDs2(java.lang.String gdbVersion,
                            int layerOrTableID,
                            java.lang.String definitionExpression,
                            IQueryFilter queryFilter)
                     throws java.io.IOException,
                            AutomationException

queryIDs2

Specified by:

queryIDs2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

definitionExpression - The definitionExpression (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryHTMLPopups2

public IStringArray queryHTMLPopups2(java.lang.String gdbVersion,
                                     int layerOrTableID,
                                     ILongArray objectIDs)
                              throws java.io.IOException,
                                     AutomationException

Returns the html as text that can be used in popups.

Specified by:

queryHTMLPopups2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

objectIDs - A reference to a com.esri.arcgis.system.ILongArray (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryRelatedObjects2

public IServiceData queryRelatedObjects2(java.lang.String gdbVersion,
                                         int sourceLayerOrTableID,
                                         ILongArray objectIDsInSource,
                                         int relationshipID,
                                         java.lang.String targetDefinitionExpression,
                                         java.lang.String targetTableProps,
                                         boolean groupBySourceOIDs,
                                         ISpatialReference outSR,
                                         ITimeReference outTR,
                                         double maximumAllowableOffset,
                                         IServiceDataOptions serviceDataOptions)
                                  throws java.io.IOException,
                                         AutomationException

queryRelatedObjects2

Specified by:

queryRelatedObjects2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

sourceLayerOrTableID - The sourceLayerOrTableID (in)

objectIDsInSource - A reference to a com.esri.arcgis.system.ILongArray (in)

relationshipID - The relationshipID (in)

targetDefinitionExpression - The targetDefinitionExpression (in)

targetTableProps - The targetTableProps (in)

groupBySourceOIDs - The groupBySourceOIDs (in)

outSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

outTR - A reference to a com.esri.arcgis.system.ITimeReference (in)

maximumAllowableOffset - The maximumAllowableOffset (in)

serviceDataOptions - A reference to a com.esri.arcgis.carto.IServiceDataOptions (in)

Returns:

A reference to a com.esri.arcgis.carto.IServiceData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update2

public IEditResults update2(java.lang.String gdbVersion,
                            int layerOrTableID,
                            IDataObjects dataObjects,
                            boolean rollbackOnFailure)
                     throws java.io.IOException,
                            AutomationException

Updates dataobjects.

Specified by:

update2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

dataObjects - A reference to a com.esri.arcgis.carto.IDataObjects (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateAttachments2

public IEditResults updateAttachments2(java.lang.String gdbVersion,
                                       int layerOrTableID,
                                       IAttachmentDataArray attachmentDataArray,
                                       boolean rollbackOnFailure)
                                throws java.io.IOException,
                                       AutomationException

Updates Attachments.

Specified by:

updateAttachments2 in interface IGraphicFeatureServer2

Parameters:

gdbVersion - The gdbVersion (in)

layerOrTableID - The layerOrTableID (in)

attachmentDataArray - A reference to a com.esri.arcgis.geodatabase.IAttachmentDataArray (in)

rollbackOnFailure - The rollbackOnFailure (in)

Returns:

A reference to a com.esri.arcgis.carto.IEditResults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

connect

public void connect(IMapServer mapServer)
             throws java.io.IOException,
                    AutomationException

Initialize GraphicFeatureServer object with MapServer.

Specified by:

connect in interface IGraphicFeatureServerInit

Parameters:

mapServer - A reference to a com.esri.arcgis.carto.IMapServer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEnableZDefaults

public void setEnableZDefaults(boolean enableZDefaults)
                        throws java.io.IOException,
                               AutomationException

setEnableZDefaults

Specified by:

setEnableZDefaults in interface IGraphicFeatureServerInit

Parameters:

enableZDefaults - The enableZDefaults (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEnableZDefaults

public boolean isEnableZDefaults()
                          throws java.io.IOException,
                                 AutomationException

isEnableZDefaults

Specified by:

isEnableZDefaults in interface IGraphicFeatureServerInit

Returns:

The enableZDefaults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZDefaults

public void setZDefaults(double zDefaults)
                  throws java.io.IOException,
                         AutomationException

setZDefaults

Specified by:

setZDefaults in interface IGraphicFeatureServerInit

Parameters:

zDefaults - The zDefaults (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZDefaults

public double getZDefaults()
                    throws java.io.IOException,
                           AutomationException

getZDefaults

Specified by:

getZDefaults in interface IGraphicFeatureServerInit

Returns:

The zDefaults

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createReplica

public IGDSData createReplica(java.lang.String replicaName,
                              IGFSReplicaDescription replicaDescription,
                              IGPReplicaOptions repOptions,
                              IGDSExportOptions exportOptions,
                              int transportType)
                       throws java.io.IOException,
                              AutomationException

Create Replica.

Specified by:

createReplica in interface IGraphicFeatureServerReplication

Parameters:

replicaName - The replicaName (in)

replicaDescription - A reference to a com.esri.arcgis.carto.IGFSReplicaDescription (in)

repOptions - A reference to a com.esri.arcgis.geodatabase.IGPReplicaOptions (in)

exportOptions - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReplicas

public IGPReplicas getReplicas()
                        throws java.io.IOException,
                               AutomationException

The replicas in the workspace of the mxd document's data source.

Specified by:

getReplicas in interface IGraphicFeatureServerReplication

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPReplicas

Throws:

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

AutomationException - If the ArcObject component throws an exception.

unregisterReplica

public void unregisterReplica(java.lang.String replicaName)
                       throws java.io.IOException,
                              AutomationException

Unregister the replica.

Specified by:

unregisterReplica in interface IGraphicFeatureServerReplication

Parameters:

replicaName - The replicaName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportReplicaDataChanges

public IGDSData exportReplicaDataChanges(java.lang.String replicaName,
                                         IGDSExportOptions options,
                                         int transportType)
                                  throws java.io.IOException,
                                         AutomationException

Exports data changes for a replica.

Specified by:

exportReplicaDataChanges in interface IGraphicFeatureServerReplication

Parameters:

replicaName - The replicaName (in)

options - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSExportOptions (in)

transportType - A com.esri.arcgis.geodatabasedistributed.esriGDSTransportType constant (in)

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

importReplicaDataChanges

public boolean importReplicaDataChanges(int sourceType,
                                        int reconcilePolicy,
                                        IGDSData data)
                                 throws java.io.IOException,
                                        AutomationException

Import the data changes for a replica.

Specified by:

importReplicaDataChanges in interface IGraphicFeatureServerReplication

Parameters:

sourceType - A com.esri.arcgis.geodatabasedistributed.esriGDSReplicaImportSource constant (in)

reconcilePolicy - A com.esri.arcgis.geodatabase.esriReplicaReconcilePolicyType constant (in)

data - A reference to a com.esri.arcgis.geodatabasedistributed.IGDSData (in)

Returns:

The conflictsFound

Throws:

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

AutomationException - If the ArcObject component throws an exception.

alterReplica

public void alterReplica(IGPReplica replica)
                  throws java.io.IOException,
                         AutomationException

Alter the definition of a replica.

Specified by:

alterReplica in interface IGraphicFeatureServerReplication

Parameters:

replica - A reference to a com.esri.arcgis.geodatabase.IGPReplica (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initLogging

public void initLogging(ILog log)
                 throws java.io.IOException,
                        AutomationException

Initializes an object with a log.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

initLogging in interface ILogSupport

Parameters:

log - A reference to a com.esri.arcgis.system.ILog (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

handleRESTRequest

public byte[] handleRESTRequest(java.lang.String capabilities,
                                java.lang.String resourceName,
                                java.lang.String operationName,
                                java.lang.String operationInput,
                                java.lang.String outputFormat,
                                java.lang.String requestProperties,
                                java.lang.String[] responseProperties)
                         throws java.io.IOException,
                                AutomationException

Handles REST requests for SOE.

This method is invoked by ArcGIS Server's REST handler, which intercepts client's request (in URL form), parses it and passes it on to this method in form of parameter values.

The REST SOE developer must add logic to use these parameter values to determine which resource/operation is being requested and accordingly handle these requests and generate responses in the output format indicated by the "outputFormat" parameter. For more information on developing REST SOEs, please consult the Java ArcObjects Developer Guide.

Developer doc: Developing extensions > Server Object Extensions > SOE Web Services > REST Web Services > Developing SOE REST Web Services
Samples: Samples > Server Object Extensions section

Specified by:

handleRESTRequest in interface IRESTRequestHandler

Parameters:

capabilities - The capabilities supported by the SOE. An admin can choose which capabilities are enabled on a particular SOE (in ArcGIS Manager or ArcCatalog), based on certain criteria such as security roles. This list of allowed capabilities is then sent to this method, at runtime, as a comma separated list. (in)

resourceName - Name of the resource being addressed. If empty, its assumed that root resource is being addressed. (in)

operationName - Name of the operation being invoked. If empty, description of resource is returned. (in)

operationInput - Input parameters, in form of comma separated list, to the operation specified by operationName parameter. (in)

outputFormat - OutputFormat of operation. Possible formats are JSON, HTML, AMF, etc. (in)

requestProperties - The requestProperties (in)

responseProperties - The responseProperties (out)

Returns:

Output generated by the SOE

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSchema

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

This method returns the resource hierarchy of a REST based SOE. This hierarchy is in JSON format as shown in the example below:

For an SOE that has a root resource (called "root") with one operation ("operation0"), and 2 sub-resources with one operation each ("operation1" and "operation2" respectively), the schema would look like:

 {
   "name": "MyRESTSOE",
   "description": "My REST SOE with 3 resources and 1 operation each.",
   "isCollection": false,
   "operations": [
   {
      "name": "operation0",
      "parameters": ["param01"],
      "supportedOutputFormats": ["json"]
    }
 ],
 "resources": [
  {
      "name": "subresource1",
      "description": "Sub Resource 1",
      "isCollection": true,
      "operations": [
       {
          "name": "operation1",
          "parameters": ["param10", "param11"],
          "supportedOutputFormats": ["json"]
       }
    ]
  },
  {
      "name": "subresource2",
      "description": "Sub Resource 2",
      "isCollection": true,
      "operations": [
       {
          "name": "operation2",
          "parameters": ["param20", "param21"],
          "supportedOutputFormats": ["json"]
       }
    ]
  }
 ]
}

Specified by:

getSchema in interface IRESTRequestHandler

Returns:

resource hierarchy of REST SOE, as String

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.