Package com.esri.arcgisruntime.arcgisservices

Class SyncCapabilities

  • public final class SyncCapabilities
extends java.lang.Object
    Instances of this class represent capabilities supported by a sync-enabled ArcGIS feature service.
    Since:
    100.0.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isSupportsAnnotations()
      Indicates if Annotation data is available for downloading.
      boolean isSupportsAsync()
      Indicates whether you can execute sync operations asynchronously.
      boolean isSupportsAttachmentsSyncDirection()
      Indicates whether the service supports options to define how attachments will be synced.
      boolean isSupportsContingentValues()
      Indicates if Contingent Value data is available.
      boolean isSupportsDimensions()
      Indicates if Dimension data is available.
      boolean isSupportsRegisteringExistingData()
      Indicates whether the service supports registering existing datasets (*.geodatabase file) as new a sync-enabled geodatabase.
      boolean isSupportsRollbackOnFailure()
      Indicates whether the service supports rolling back edits in case of a failure during sync operations.
      boolean isSupportsSyncDirectionControl()
      Indicates whether the service allows the client application to control direction of sync - upload only, download only, or bi-directional.
      boolean isSupportsSyncModelGeodatabase()
      Indicates whether the service supports sync capabilities for the entire sync-enabled geodatabase.
      boolean isSupportsSyncModelLayer()
      Indicates whether the service supports sync capabilities independently on a layer-by-layer basis in the sync-enabled geodatabase.
      boolean isSupportsSyncModelNone()
      Indicates whether the service supports neither sync capabilities independently on a layer-by-layer basis in the sync-enabled geodatabase nor supports sync capabilities for the entire sync-enabled geodatabase.
      boolean isSupportsUtilityNetworkSystem()
      Indicates if Utility Network System data is available.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • isSupportsAnnotations

        public boolean isSupportsAnnotations()
        Indicates if Annotation data is available for downloading.

        Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Annotation data is also available from the service, for generation of, or downloading to, an offline geodatabase.

        Once this data is taken offline to a local geodatabase, any inserts, edits or deletions will NOT be applied to the server data when the geodatabase is re-synchronized. If features linked to the annotation have been changed, the server WILL apply the feature-linked-annotation updates. Another download from the server will replace any offline inserts, edits or deletions of Annotation features.

        Returns:
        indicates if Annotation data is available for downloading
        Since:
        100.14.0
        See Also:
        GenerateGeodatabaseParameters.getSyncAnnotations()

      • isSupportsAsync

        public boolean isSupportsAsync()
        Indicates whether you can execute sync operations asynchronously. Only present if syncEnabled is true.
        Returns:
        true if the feature service supports executing sync operations asynchronously, otherwise false
        Since:
        100.0.0

      • isSupportsSyncModelGeodatabase

        public boolean isSupportsSyncModelGeodatabase()
        Indicates whether the service supports sync capabilities for the entire sync-enabled geodatabase. All layers in the geodatabase will be synchronized together in the same direction.
        Returns:
        true if the feature service supports sync model geodatabase, otherwise false
        Since:
        100.0.0

      • isSupportsSyncModelLayer

        public boolean isSupportsSyncModelLayer()
        Indicates whether the service supports sync capabilities independently on a layer-by-layer basis in the sync-enabled geodatabase. For example, one layer can upload changes while another downloads during sync. A perLayer sync model also allows clients to limit the sync to a subset of layers in the geodatabase.
        Returns:
        true if the feature service supports sync model layer, otherwise false
        Since:
        100.0.0

      • isSupportsContingentValues

        public boolean isSupportsContingentValues()
        Indicates if Contingent Value data is available.

        Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Contingent Value data is also available from the service, for generation of an offline geodatabase and for resynchronization.

        Returns:
        indicates if Contingent Value data is available
        Since:
        100.13.0
        See Also:
        GenerateGeodatabaseParameters.getSyncContingentValues()

      • isSupportsDimensions

        public boolean isSupportsDimensions()
        Indicates if Dimension data is available.

        Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Dimension data is also available from the service, for generation of an offline geodatabase and for resynchronization.

        Returns:
        indicates if Dimension data is available
        Since:
        100.14.0
        See Also:
        GenerateGeodatabaseParameters.getSyncDimensions()

      • isSupportsRegisteringExistingData

        public boolean isSupportsRegisteringExistingData()
        Indicates whether the service supports registering existing datasets (*.geodatabase file) as new a sync-enabled geodatabase. This is useful when you already have a geodatabase that you want to sync on multiple devices independently without affecting each other.
        Returns:
        true if the feature service supports registering existing data, otherwise false
        Since:
        100.0.0

      • isSupportsRollbackOnFailure

        public boolean isSupportsRollbackOnFailure()
        Indicates whether the service supports rolling back edits in case of a failure during sync operations.
        Returns:
        true if the feature service supports rollback on sync failure, otherwise false
        Since:
        100.0.0

      • isSupportsSyncDirectionControl

        public boolean isSupportsSyncDirectionControl()
        Indicates whether the service allows the client application to control direction of sync - upload only, download only, or bi-directional.
        Returns:
        true if the feature service supports sync direction control, otherwise false
        Since:
        100.0.0

      • isSupportsSyncModelNone

        public boolean isSupportsSyncModelNone()
        Indicates whether the service supports neither sync capabilities independently on a layer-by-layer basis in the sync-enabled geodatabase nor supports sync capabilities for the entire sync-enabled geodatabase.
        Returns:
        true if the feature service supports none of the sync models, otherwise false
        Since:
        100.0.0

      • isSupportsAttachmentsSyncDirection

        public boolean isSupportsAttachmentsSyncDirection()
        Indicates whether the service supports options to define how attachments will be synced. If true, the service will accept setting the attachments Sync Direction during the operation to create a replica.
        Returns:
        true if the feature service supports setting the attachment sync direction parameter, otherwise false
        Since:
        100.0.0

      • isSupportsUtilityNetworkSystem

        public boolean isSupportsUtilityNetworkSystem()
        Indicates if Utility Network System data is available.

        Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Utility Network System data is also available from the service, for generation of an offline geodatabase and for resynchronization.

        Returns:
        true if Utility Network System data is available
        Since:
        100.11.0
        See Also:
        GenerateGeodatabaseParameters.getUtilityNetworkSyncMode()