com.esri.arcgis.gisclient
Class UploadItem

java.lang.Object
  com.esri.arcgis.gisclient.UploadItem

All Implemented Interfaces:

IUploadItem, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class UploadItem
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IUploadItem

The UploadItem object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

UploadItem()
Constructs a UploadItem using ArcGIS Engine.

UploadItem(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
UploadItem theUploadItem = (UploadItem) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
Date	getDate() The date for the upload (in the server's time zone).
String	getDescription() The description of the uploaded item.
String	getFilePath() The path of this uploaded item.
String	getID() The ID of the uploaded item.
String	getName() The name of the uploaded item.
String	getPathOnServer() The path of this uploaded item on server.
int	hashCode() the hashcode for this object
boolean	isCommitted() Indicates if the upload item has been committed.
void	setCommitted(boolean committed) Indicates if the upload item has been committed.
void	setDate(Date pDate) The date for the upload (in the server's time zone).
void	setDescription(String pDesc) The description of the uploaded item.
void	setFilePath(String pPath) The path of this uploaded item.
void	setID(String pItemID) The ID of the uploaded item.
void	setName(String pName) The name of the uploaded item.
void	setPathOnServer(String pPathOnServer) The path of this uploaded item on server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

UploadItem

public UploadItem()
           throws IOException,
                  UnknownHostException

Constructs a UploadItem using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

UploadItem

public UploadItem(Object obj)
           throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setName

public void setName(String pName)
             throws IOException,
                    AutomationException

The name of the uploaded item.

Product Availability

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

Specified by:

setName in interface IUploadItem

Parameters:

pName - The pName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the uploaded item.

Product Availability

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

Specified by:

getName in interface IUploadItem

Returns:

The pName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setID

public void setID(String pItemID)
           throws IOException,
                  AutomationException

The ID of the uploaded item.

Product Availability

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

Specified by:

setID in interface IUploadItem

Parameters:

pItemID - The pItemID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

public String getID()
             throws IOException,
                    AutomationException

The ID of the uploaded item.

Product Availability

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

Specified by:

getID in interface IUploadItem

Returns:

The pItemID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilePath

public void setFilePath(String pPath)
                 throws IOException,
                        AutomationException

The path of this uploaded item.

Product Availability

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

Specified by:

setFilePath in interface IUploadItem

Parameters:

pPath - The pPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilePath

public String getFilePath()
                   throws IOException,
                          AutomationException

The path of this uploaded item.

Product Availability

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

Specified by:

getFilePath in interface IUploadItem

Returns:

The pPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPathOnServer

public void setPathOnServer(String pPathOnServer)
                     throws IOException,
                            AutomationException

The path of this uploaded item on server.

Product Availability

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

Specified by:

setPathOnServer in interface IUploadItem

Parameters:

pPathOnServer - The pPathOnServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathOnServer

public String getPathOnServer()
                       throws IOException,
                              AutomationException

The path of this uploaded item on server.

Product Availability

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

Specified by:

getPathOnServer in interface IUploadItem

Returns:

The pPathOnServer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String pDesc)
                    throws IOException,
                           AutomationException

The description of the uploaded item.

Product Availability

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

Specified by:

setDescription in interface IUploadItem

Parameters:

pDesc - The pDesc (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description of the uploaded item.

Product Availability

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

Specified by:

getDescription in interface IUploadItem

Returns:

The pDesc

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDate

public void setDate(Date pDate)
             throws IOException,
                    AutomationException

The date for the upload (in the server's time zone).

Product Availability

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

Specified by:

setDate in interface IUploadItem

Parameters:

pDate - The pDate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDate

public Date getDate()
             throws IOException,
                    AutomationException

The date for the upload (in the server's time zone).

Product Availability

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

Specified by:

getDate in interface IUploadItem

Returns:

The pDate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCommitted

public void setCommitted(boolean committed)
                  throws IOException,
                         AutomationException

Indicates if the upload item has been committed.

Product Availability

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

Specified by:

setCommitted in interface IUploadItem

Parameters:

committed - The committed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCommitted

public boolean isCommitted()
                    throws IOException,
                           AutomationException

Indicates if the upload item has been committed.

Product Availability

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

Specified by:

isCommitted in interface IUploadItem

Returns:

The committed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.