com.esri.arcgis.geodatabase
Interface IReplicaDescription

All Superinterfaces:
Serializable
All Known Subinterfaces:
IReplicaDescription2
All Known Implementing Classes:
ReplicaDescription

public interface IReplicaDescription
extends Serializable

Provides access to members which set and return the properties of a ReplicaDescription object.

Superseded By

IReplicaDescription2

Remarks

This interface provides properties and methods for specifying the datasets to be used during check out. The IReplicaFilterDescriptionEdit interface can then be used to define which rows are to be checked out from these datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addDatasetNames(IEnumName datasetNames)
          Adding dataset names to the existing list of replica description dataset names.
 int findTable(IName datasetName)
          Gets the index number of a dataset.
 IEnumName getDatasetNames()
          A list of dataset names to include in a replica.
 int getReplicaModelType()
          Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.
 IName getTableName(int index)
          The name of a dataset to check out.
 int getTableNameCount()
          The number of table type objects that will be checked out.
 void init(IEnumName enumNames, IWorkspaceName outputWSName, boolean reuseSchema, int deType)
          Defines the datasets to replica or extract and the output geodatabase.
 boolean isPrivateTable(int index)
          Indicates if a dataset is private or not.
 boolean isTableExcluded(int index)
          Indicates if a table is to be excluded from a replica.
 void setIsPrivateTable(int index, boolean isPrivate)
          Indicates if a dataset is private or not.
 void setReplicaModelType(int modelType)
          Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.
 void setTableExcluded(int index, boolean exclude)
          Indicates if a table is to be excluded from a replica.
 

Method Detail

init

void init(IEnumName enumNames,
          IWorkspaceName outputWSName,
          boolean reuseSchema,
          int deType)
          throws IOException,
                 AutomationException
Defines the datasets to replica or extract and the output geodatabase.

Remarks

When defining a ReplicaDescription object to use in a check out or a data extraction, this method must be called before using any of the other properties and methods.

The Init method expands the enumNames list to include related datasets that may not already be in the enumNames list. For example, if the enumNames list includes a FeatureClass involved in a RelationshipClass, the Init method adds the related table to the check-out. This is done to maintain the integrity of the geodatabase. The FindTable method and the TableNameCount, TableName and TableExcluded properties apply to the expanded enumNames list.

The expanded list only contains objects that implement ITableName such as FeatureClasses, Tables and AttributedRelationshipClasses. Objects such as GeometricNetworks and FeatureDatasets are included in the checkout, but are not returned from this list. The properties of the objects returned can be used to get these objects if needed.

For the current release, all esriDataExtraction types are valid except esriDataReplication for the detype parameter. The OutputWSName parameter must be a workspacename for a personal or ArcSDE geodatabase.

Set ReuseSchema to True if you intend to check out or extract data to a workspace that already has a schema to match the data to be checked out or extracted.

To add a FeatureClass from a FeatureDataset, you must first add the FeatureDataset to the enumNames and call Init. This expands the description to include all FeatureClasses from the FeatureDataset. You can then set the IReplicaDescripion::TableExcluded property to false for any feature classes that you don't want to inlcluce in the check-out.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
enumNames - A reference to a com.esri.arcgis.system.IEnumName (in)
outputWSName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
reuseSchema - The reuseSchema (in)
deType - A com.esri.arcgis.geodatabase.esriDataExtractionType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDatasetNames

IEnumName getDatasetNames()
                          throws IOException,
                                 AutomationException
A list of dataset names to include in a replica.

Remarks

This enumeration is the unexpanded enumNames enumeration that was passed into the Init method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IEnumName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTableNameCount

int getTableNameCount()
                      throws IOException,
                             AutomationException
The number of table type objects that will be checked out.

Remarks

This value returned may be different from the number of datasets passed into the Init method. This is because the Init method expands the list of datasets to ensure database integrity.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTableName

IName getTableName(int index)
                   throws IOException,
                          AutomationException
The name of a dataset to check out.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableExcluded

void setTableExcluded(int index,
                      boolean exclude)
                      throws IOException,
                             AutomationException
Indicates if a table is to be excluded from a replica.

Product Availability

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

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

isTableExcluded

boolean isTableExcluded(int index)
                        throws IOException,
                               AutomationException
Indicates if a table is to be excluded from a replica.

Product Availability

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

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

setReplicaModelType

void setReplicaModelType(int modelType)
                         throws IOException,
                                AutomationException
Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
modelType - A com.esri.arcgis.geodatabase.esriReplicaModelType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaModelType

int getReplicaModelType()
                        throws IOException,
                               AutomationException
Defines whether to output the data as simple datasets or as they are defined in the master geodatabase.

Remarks

The ReplicaModelType property defines whether to output the data as simple datasets (esriModelTypeSimple) or as they are defined in the master geodatabase (esriModelTypeFullGeodatabase).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.geodatabase.esriReplicaModelType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findTable

int findTable(IName datasetName)
              throws IOException,
                     AutomationException
Gets the index number of a dataset.

Remarks

This property may return indexes for Name objects that were not passed into the Init method. This is because the Init method expands the list of datasets to ensure database integrity. The index returned can be used with the TableName property to get name object back from the list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
datasetName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDatasetNames

void addDatasetNames(IEnumName datasetNames)
                     throws IOException,
                            AutomationException
Adding dataset names to the existing list of replica description dataset names.

Remarks

The AddDatasetNames method can be used to add dataset names to the replica description after the init method has been called.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
datasetNames - A reference to a com.esri.arcgis.system.IEnumName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsPrivateTable

void setIsPrivateTable(int index,
                       boolean isPrivate)
                       throws IOException,
                              AutomationException
Indicates if a dataset is private or not.

Product Availability

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

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

isPrivateTable

boolean isPrivateTable(int index)
                       throws IOException,
                              AutomationException
Indicates if a dataset is private or not.

Product Availability

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

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