com.esri.arcgis.gisclient
Interface IAdminUploadsClient

All Superinterfaces:

Serializable

All Known Implementing Classes:

UploadsClient

public interface IAdminUploadsClient
extends Serializable

Provides access to properties and members the uploads client object.

Product Availability

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

Method Summary

void	adminCommit(IUploadItem pUploadItem, ILongArray pPartNumbers) Commits a registered upload item.
void	adminDelete(IUploadItem pUploadItem) Deletes the upload item.
ILongArray	adminGetPartNumbers(IUploadItem pUploadItem) Returns the numbers of the parts that have already been uploaded for the upload item.
IUploadItem	adminRegister(String itemName, String description) Instruct the server to reserve space for a new upload item, to be uploaded in parts.
IUploadItem	adminUploadFile(String file, String description) Uploads a file to the server without breaking it into parts.
void	adminUploadPart(IUploadItem pUploadItem, String file, int uploadPartNumber, long offset, int bytesToWrite) Uploads a part for the upload item.
IUploadItem	getUploadItem(String itemID) Returns the upload item with the given itemID.
IEnumUploadItem	getUploadItems() Returns all uploaded items.

Method Detail

adminUploadFile

IUploadItem adminUploadFile(String file,
                            String description)
                            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)

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.

adminRegister

IUploadItem adminRegister(String itemName,
                          String description)
                          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)

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.

adminUploadPart

void adminUploadPart(IUploadItem pUploadItem,
                     String file,
                     int uploadPartNumber,
                     long offset,
                     int bytesToWrite)
                     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)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

adminGetPartNumbers

ILongArray adminGetPartNumbers(IUploadItem pUploadItem)
                               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)

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.

adminCommit

void adminCommit(IUploadItem pUploadItem,
                 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)

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.

getUploadItems

IEnumUploadItem getUploadItems()
                               throws IOException,
                                      AutomationException

Returns all uploaded items.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUploadItem

IUploadItem getUploadItem(String itemID)
                          throws IOException,
                                 AutomationException

Returns the upload item with the given itemID.

Product Availability

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

Parameters:

itemID - The itemID (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.

adminDelete

void adminDelete(IUploadItem pUploadItem)
                 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)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.