com.esri.arcgis.geodatabaseextensions
Interface ICadastralJob

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadastralJob

public interface ICadastralJob
extends Serializable

Provides access to members that control the properties of a cadastral job.

Remarks

This is a light-weight object used to retrieve and update the properties of a cadastral job. Property values are stored in the jobs table.

Product Availability

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

Method Summary

void	addControlPoint(int pointID) Adds a control point to the job.
void	addEditParcel(int parcelID) Adds an edit parcel to the job.
IFIDSet	getAdjustmentAreaParcels() All parcels for the complete area of the job.
String	getCommitDate() The date the cadastral job was committed.
IFIDSet	getControlPoints() The control points for the cadastral job.
String	getDescription() The cadastral job description.
IFIDSet	getEditParcels() Edit parcels for the cadastral job.
Object	getExtendedAttribute(int fieldPosition) The value of an extended attribute.
int	getID() The ObjectID of the Cadastral Job.
IFIDSet	getJobParcels() All the parcels participating in the cadastral job.
String	getModifiedDate() The date the cadastral job was last modified.
String	getName() The cadastral job name.
String	getOwner() The owner of the cadastral job.
String	getStartDate() The start date for the cadastral job.
int	getStatus() The cadastral job status.
void	removeControlPoint(int pointID) Removes a control point from the job.
void	removeEditParcel(int parcelID) Removes a parcel from the job.
void	setAdjustmentAreaParcels(IFIDSet adjustmentAreaParcelIDs) All parcels for the complete area of the job.
void	setControlPoints(IFIDSet controlPointslIDs) The control points for the cadastral job.
void	setDescription(String description) The cadastral job description.
void	setEditParcels(IFIDSet editParcelIDs) Edit parcels for the cadastral job.
void	setExtendedAttribute(int fieldPosition, Object value) The value of an extended attribute.
void	setName(String name) The cadastral job name.
void	setOwner(String owner) The owner of the cadastral job.
void	setStatus(int status) The cadastral job status.

Method Detail

getID

int getID()
          throws IOException,
                 AutomationException

The ObjectID of the Cadastral Job.

Remarks

The ObjectID of the CadastralJob.

Use the ID property to retrieve the ID attribute of the cadastral job. Use the GetJob method to retrieve a CadastralJob object from the cadastral fabric.

Product Availability

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

Returns:

The jobID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The cadastral job description.

Remarks

The description of the cadastral job.

Use this property to retrieve or set the description for the cadastral job. Use the UpdateJob method to update the cadastral job with any changes.

Product Availability

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

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException

The cadastral job description.

Product Availability

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

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The cadastral job name.

Remarks

The name of the cadastral job.

Use this property to retrieve or set the name for the cadastral job. The name must be unique. Use the UpdateJob method to update the cadastral job with any changes.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The cadastral job name.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

int getStatus()
              throws IOException,
                     AutomationException

The cadastral job status.

Remarks

The status of the cadastral job.

Use this property to retrieve or set the status for the cadastral job. The status value is a coded value in the status field of the Jobs table.

Valid system values:

0 - Active

1 - Committed

2 - Remote

3 - Hold

Product Availability

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

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStatus

void setStatus(int status)
               throws IOException,
                      AutomationException

The cadastral job status.

Product Availability

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

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOwner

String getOwner()
                throws IOException,
                       AutomationException

The owner of the cadastral job.

Remarks

The owner name of the cadastral job.

Product Availability

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

Returns:

The owner

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOwner

void setOwner(String owner)
              throws IOException,
                     AutomationException

The owner of the cadastral job.

Product Availability

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

Parameters:

owner - The owner (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedAttribute

Object getExtendedAttribute(int fieldPosition)
                            throws IOException,
                                   AutomationException

The value of an extended attribute.

Product Availability

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

Parameters:

fieldPosition - The fieldPosition (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedAttribute

void setExtendedAttribute(int fieldPosition,
                          Object value)
                          throws IOException,
                                 AutomationException

The value of an extended attribute.

Product Availability

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

Parameters:

fieldPosition - The fieldPosition (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartDate

String getStartDate()
                    throws IOException,
                           AutomationException

The start date for the cadastral job.

Remarks

Use this property to retrieve the start date for the cadastral job.

Product Availability

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

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModifiedDate

String getModifiedDate()
                       throws IOException,
                              AutomationException

The date the cadastral job was last modified.

Remarks

Use this property to retrieve the date for the last time the cadastral job was modified.

Product Availability

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

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCommitDate

String getCommitDate()
                     throws IOException,
                            AutomationException

The date the cadastral job was committed.

Remarks

The date the job was commited for the cadastral fabric. Use the CommitDate property to return the date the cadastral job was committed to the cadastral fabric. This is the date that the Status property of the cadastral job was changed to committed.

Product Availability

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

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEditParcels

IFIDSet getEditParcels()
                       throws IOException,
                              AutomationException

Edit parcels for the cadastral job.

Remarks

The edit parcels for the cadastral job.

The EditParcels property can be used to retrieve or set which parcels will participate as edit parcels in the cadastral job. The FIDSet parameter contains the objectIDs of the edit parcel features in the job. Any existing edit parcels in the job will be replaced by the FIDSet set by this property. To individually add a parcel to the existing set, use the AddEditParcel method on this interface. Use the UpdateJob method to update the cadastral job with any changes.

The parcels in a cadastral job that are marked as edit parcels for a job may not participate as edit parcels in any other job (they may, however, participate as standard job parcels) until the job is committed to the cadastral fabric.

The id's for the edit parcels are added to the JobObjects table. When the job is committed to the cadastral fabric, these rows are removed from the JobObjects table.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditParcels

void setEditParcels(IFIDSet editParcelIDs)
                    throws IOException,
                           AutomationException

Edit parcels for the cadastral job.

Product Availability

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

Parameters:

editParcelIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAdjustmentAreaParcels

IFIDSet getAdjustmentAreaParcels()
                                 throws IOException,
                                        AutomationException

All parcels for the complete area of the job.

Remarks

The AdjustmentAreaParcels property can be used to retrieve or set which parcels will participate as area of adjustment parcels in the cadastral job. The FIDSet parameter contains the objectIDs of the adjustment area parcel features in the job.

Any existing adjustment area parcels in the job will be replaced by the FIDSet set by this property. To individually add a parcel to the existing set, use the AddAdjustmentParcel method on this interface. Use the UpdateJob method to update the cadastral job with any changes.

The attributes of parcels participating as area of adjustment parcels cannot be edited. Only the geometry may be edited indirectly via an adjustment in the cadastral editor.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdjustmentAreaParcels

void setAdjustmentAreaParcels(IFIDSet adjustmentAreaParcelIDs)
                              throws IOException,
                                     AutomationException

All parcels for the complete area of the job.

Product Availability

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

Parameters:

adjustmentAreaParcelIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getControlPoints

IFIDSet getControlPoints()
                         throws IOException,
                                AutomationException

The control points for the cadastral job.

Remarks

The control points for the cadastral job.

The ControlPoints property can be used to retrieve or set which control points will participate in the cadastral job. The FIDSet parameter contains the objectIDs of the control point features in the job.

Any existing control points in the job will be replaced by the FIDSet set by this property. To individually add a control point to the existing set, use the AddControl method on this interface. Use the UpdateJob method to update the cadastral job with any changes.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setControlPoints

void setControlPoints(IFIDSet controlPointslIDs)
                      throws IOException,
                             AutomationException

The control points for the cadastral job.

Product Availability

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

Parameters:

controlPointslIDs - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addEditParcel

void addEditParcel(int parcelID)
                   throws IOException,
                          AutomationException

Adds an edit parcel to the job.

Remarks

Add an edit parcel to the job.

Use the AddEditParcel method to add an edit parcel to the cadastral job. Call the ICadastralFabric::UpdateJob method to store the changes. The update will fail if the parcel is marked for edits in another job.

Product Availability

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

Parameters:

parcelID - The parcelID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeEditParcel

void removeEditParcel(int parcelID)
                      throws IOException,
                             AutomationException

Removes a parcel from the job.

Remarks

Remove an edit parcel from the job.

Use the RemoveEditParcelmethod to remove an edit parcel from the cadastral job. Call the ICadastralFabric::UpdateJob method to store the changes.

Product Availability

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

Parameters:

parcelID - The parcelID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addControlPoint

void addControlPoint(int pointID)
                     throws IOException,
                            AutomationException

Adds a control point to the job.

Remarks

Add a control point to the job.

Use the AddControlPoint method to add a control point to the cadastral job. Call the ICadastralFabric::UpdateJob method to store the changes.

Product Availability

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

Parameters:

pointID - The pointID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeControlPoint

void removeControlPoint(int pointID)
                        throws IOException,
                               AutomationException

Removes a control point from the job.

Remarks

Remove a control point from the job.

Use the RemoveControlPoint method to remove a control point to the cadastral job. Call the ICadastralFabric::UpdateJob method to store the changes.

Product Availability

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

Parameters:

pointID - The pointID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobParcels

IFIDSet getJobParcels()
                      throws IOException,
                             AutomationException

All the parcels participating in the cadastral job.

Remarks

All the parcels participating in the cadastral job.

Use this property to retrieve the FIDSet containing the ObjectIDs of all the parcels participating in the cadastral job.

Question:

What is the difference between ICadastralJob::AdjustmentAreaParcels and ICadastralJob::JobParcels?

Answer:

The get property ::AdjustmentAreaParcels will return the JobParcels minus the edit parcels in the cadastral job.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.