com.esri.arcgis.geodatabase
Class WorkspaceProperty

java.lang.Object
  extended by com.esri.arcgis.geodatabase.WorkspaceProperty
All Implemented Interfaces:
IWorkspaceProperty, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class WorkspaceProperty
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceProperty

Workspace Property object.

Remarks

A WorkspaceProperty class provides information about a workspace. WorkspaceProperty objects are returned by the IWorkspaceProperties.Property method. Use the IWorkspaceProperty interface to determine if the workspace supports determination of the specified property (the property group/property type was added at a later release than the component the application is working with).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
WorkspaceProperty()
          Constructs a WorkspaceProperty using ArcGIS Engine.
WorkspaceProperty(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WorkspaceProperty theWorkspaceProperty = (WorkspaceProperty) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 Object getPropertyValue()
          The value of this property.
 int hashCode()
          the hashcode for this object
 boolean isReadOnly()
          Indicates if this property is read only.
 boolean isSupported()
          Indicates if this property is supported.
 void setIsReadOnly(boolean isReadOnly)
          Indicates if this property is read only.
 void setIsSupported(boolean isSupported)
          Indicates if this property is supported.
 void setPropertyValue(Object propertyValue)
          The value of this property.
 
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

WorkspaceProperty

public WorkspaceProperty()
                  throws IOException,
                         UnknownHostException
Constructs a WorkspaceProperty using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

WorkspaceProperty

public WorkspaceProperty(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
WorkspaceProperty theWorkspaceProperty = (WorkspaceProperty) obj;

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

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

getPropertyValue

public Object getPropertyValue()
                        throws IOException,
                               AutomationException
The value of this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

The PropertyValue is returned as an Object. Applications are responsible for checking the type of the object and accessing the appropriate member value.

Specified by:
getPropertyValue in interface IWorkspaceProperty
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertyValue

public void setPropertyValue(Object propertyValue)
                      throws IOException,
                             AutomationException
The value of this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPropertyValue in interface IWorkspaceProperty
Parameters:
propertyValue - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly()
                   throws IOException,
                          AutomationException
Indicates if this property is read only.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isReadOnly in interface IWorkspaceProperty
Returns:
The isReadOnly
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsReadOnly

public void setIsReadOnly(boolean isReadOnly)
                   throws IOException,
                          AutomationException
Indicates if this property is read only.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsReadOnly in interface IWorkspaceProperty
Parameters:
isReadOnly - The isReadOnly (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupported

public boolean isSupported()
                    throws IOException,
                           AutomationException
Indicates if this property is supported.

Remarks

If the IsSupported property returns False, then the workspace does not support determination of the specified property (the property group/property type was added at a later release than the component the application is working with).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isSupported in interface IWorkspaceProperty
Returns:
The isSupported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsSupported

public void setIsSupported(boolean isSupported)
                    throws IOException,
                           AutomationException
Indicates if this property is supported.

Remarks

If the IsSupported property returns False, then the workspace does not support determination of the specified property (the property group/property type was added at a later release than the component the application is working with).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsSupported in interface IWorkspaceProperty
Parameters:
isSupported - The isSupported (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.