com.esri.arcgis.geodatabasedistributed
Interface ISchemaChangeInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchemaChangeInfo

public interface ISchemaChangeInfo
extends Serializable

Provides access to the replica schema change info.

Remarks

This interface provides methods to retrieve and apply schema changes to a replica.

A reference to this interface is returned from the ISchemaChanges::GetChanges method.

Product Availability

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

Method Summary

IEnumSchemaChange	getChanges() The schema changes.
IPropertySet	getExtendedProperties() Properties associated with the schema change object.
Object	getFromObject() The source replicas representation of the schema.
int	getSchemaChangeType() Type of schema change.
Object	getToObject() The target replicas representation of the schema.
Object	getToParent() The parent container of the schema change object.
boolean	isApplySchemaChange() Indicates if schema changes will be applied.
void	setApplySchemaChange(boolean applySchemaChange) Indicates if schema changes will be applied.

Method Detail

getSchemaChangeType

int getSchemaChangeType()
                        throws IOException,
                               AutomationException

Type of schema change.

Remarks

This property returns the type of schema changes. This is returned as a value of the esriSchemaChangeConstant. See the esriSchemaChangeConstant for more information.

Product Availability

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

Returns:

A com.esri.arcgis.geodatabasedistributed.esriSchemaChangeType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromObject

Object getFromObject()
                     throws IOException,
                            AutomationException

The source replicas representation of the schema.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToObject

Object getToObject()
                   throws IOException,
                          AutomationException

The target replicas representation of the schema.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToParent

Object getToParent()
                   throws IOException,
                          AutomationException

The parent container of the schema change object.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplySchemaChange

boolean isApplySchemaChange()
                            throws IOException,
                                   AutomationException

Indicates if schema changes will be applied.

Remarks

Returns TRUE if the schema change will be applied. Returns FALSE if the schema change will not be applied.

Product Availability

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

Returns:

The applySchemaChange

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplySchemaChange

void setApplySchemaChange(boolean applySchemaChange)
                          throws IOException,
                                 AutomationException

Indicates if schema changes will be applied.

Remarks

Set this property to TRUE to apply the schema change. Set this property to FALSE if you don't want to apply this schema change.

Product Availability

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

Parameters:

applySchemaChange - The applySchemaChange (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChanges

IEnumSchemaChange getChanges()
                             throws IOException,
                                    AutomationException

The schema changes.

Remarks

This method returns the schema changes as a reference to IEnumSchemaChangeInfo.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabasedistributed.IEnumSchemaChange

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedProperties

IPropertySet getExtendedProperties()
                                   throws IOException,
                                          AutomationException

Properties associated with the schema change object.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.