com.esri.arcgis.geodatabase
Interface IWorkspaceProperty

All Superinterfaces:
Serializable
All Known Implementing Classes:
WorkspaceProperty

public interface IWorkspaceProperty
extends Serializable

Provides access to members that control the Workspace property object.

Remarks

The IWorkspaceProperty interface is supported by WorkspaceProperty objects that are returned by the IWorkspaceProperties::Property method. 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.

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


Method Summary
 Object getPropertyValue()
          The value of this property.
 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.
 

Method Detail

getPropertyValue

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.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertyValue

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

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

isReadOnly

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

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

setIsReadOnly

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

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

isSupported

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

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

setIsSupported

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

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