com.esri.arcgis.gisclient
Interface IServiceUploadsClient

All Superinterfaces:

Serializable

All Known Implementing Classes:

UploadsClient

public interface IServiceUploadsClient
extends Serializable

Provides access to properties and members of the uploads client object.

Product Availability

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

Method Summary

long	getServiceMaxUploadSizeInBytes(IAGSServerObjectName pTargetSevice) Returns the maximum upload size for a service.
void	serviceCommit(IUploadItem pUploadItem, IAGSServerObjectName pTargetService, ILongArray pPartNumbers) Commits a registered upload item.
void	serviceDelete(IUploadItem pUploadItem, IAGSServerObjectName pTargetService) Deletes the upload item.
ILongArray	serviceGetPartNumbers(IUploadItem pUploadItem, IAGSServerObjectName pTargetService) Returns the numbers of the parts that have already been uploaded for the upload item.
IUploadItem	serviceRegister(String itemName, String description, IAGSServerObjectName pTargetService) Instruct the server to reserve space for a new upload item, to be uploaded in parts.
IUploadItem	serviceUploadFile(String file, String description, IAGSServerObjectName pTargetService) Uploads a file to the server without breaking it into parts.
void	serviceUploadPart(IUploadItem pUploadItem, String file, int uploadPartNumber, long offset, int bytesToWrite, IAGSServerObjectName pTargetService) Uploads a part for the upload item.

Method Detail

serviceUploadFile

IUploadItem serviceUploadFile(String file,
                              String description,
                              IAGSServerObjectName pTargetService)
                              throws IOException,
                                     AutomationException

Uploads a file to the server without breaking it into parts.

Product Availability

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

Parameters:

file - The file (in)

description - The description (in)

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

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceRegister

IUploadItem serviceRegister(String itemName,
                            String description,
                            IAGSServerObjectName pTargetService)
                            throws IOException,
                                   AutomationException

Instruct the server to reserve space for a new upload item, to be uploaded in parts.

Product Availability

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

Parameters:

itemName - The itemName (in)

description - The description (in)

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

Returns:

A reference to a com.esri.arcgis.gisclient.IUploadItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceUploadPart

void serviceUploadPart(IUploadItem pUploadItem,
                       String file,
                       int uploadPartNumber,
                       long offset,
                       int bytesToWrite,
                       IAGSServerObjectName pTargetService)
                       throws IOException,
                              AutomationException

Uploads a part for the upload item.

Product Availability

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

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

file - The file (in)

uploadPartNumber - The uploadPartNumber (in)

offset - Unsigned 64-bit int (in)

bytesToWrite - The bytesToWrite (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceGetPartNumbers

ILongArray serviceGetPartNumbers(IUploadItem pUploadItem,
                                 IAGSServerObjectName pTargetService)
                                 throws IOException,
                                        AutomationException

Returns the numbers of the parts that have already been uploaded for the upload item.

Product Availability

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

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceCommit

void serviceCommit(IUploadItem pUploadItem,
                   IAGSServerObjectName pTargetService,
                   ILongArray pPartNumbers)
                   throws IOException,
                          AutomationException

Commits a registered upload item.

Product Availability

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

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serviceDelete

void serviceDelete(IUploadItem pUploadItem,
                   IAGSServerObjectName pTargetService)
                   throws IOException,
                          AutomationException

Deletes the upload item.

Product Availability

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

Parameters:

pUploadItem - A reference to a com.esri.arcgis.gisclient.IUploadItem (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServiceMaxUploadSizeInBytes

long getServiceMaxUploadSizeInBytes(IAGSServerObjectName pTargetSevice)
                                    throws IOException,
                                           AutomationException

Returns the maximum upload size for a service.

Product Availability

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

Parameters:

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

Returns:

Unsigned 64-bit int

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.