Interface IReplicaMetadata
ReplicaMetadata class encapsulates all sync metadata for remote storage instance.
Namespace: Terrasoft.Sync
Assembly: Terrasoft.Sync.dll
Syntax
public interface IReplicaMetadata
Remarks
Items from IMetadataStore don't represented in database.
Properties
LocalStoreId
Local store Id, associated with the metadata.
Declaration
Guid LocalStoreId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
RemoteStoreId
Remote store Id, associated with the metadata.
Declaration
Guid RemoteStoreId { get; set; }
Property Value
Type | Description |
---|---|
System.Guid |
Methods
CollectChangesInSyncedEntities(UserConnection, String, DateTime)
Updates sync metadata table for synced bpm'online entities.
Declaration
void CollectChangesInSyncedEntities(UserConnection userConnection, string schemaName, DateTime lastSyncVersion)
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | UserConnection instance. |
System.String | schemaName | Sync entity name. |
System.DateTime | lastSyncVersion | Last synchronization date. |
Remarks
If entity was changed in bpm'online after last synchronization, SysSyncMetadata Version column will be filled with entity modification date, converted to Utc.
CollectNewDetailsForSyncedEntities(UserConnection, DetailEntityConfig, String, DateTime)
Creates records in SysSyncMetaData for new detail records.
Declaration
void CollectNewDetailsForSyncedEntities(UserConnection userConnection, DetailEntityConfig detailEntityConfig, string remoteItemName, DateTime lastSyncVersion = default(DateTime))
Parameters
Type | Name | Description |
---|---|---|
UserConnection | userConnection | UserConnection instance. |
DetailEntityConfig | detailEntityConfig | DetailEntityConfig instance. |
System.String | remoteItemName | Remote storage item name. |
System.DateTime | lastSyncVersion | Last synchronization date. |
EnumerateItemsWithChangesInBpm(SyncContext)
Returns changed after last synchronization and not synced in current synchronization bpm'online entities ItemMetadata.
Declaration
IEnumerable<ItemMetadata> EnumerateItemsWithChangesInBpm(SyncContext context)
Parameters
Type | Name | Description |
---|---|---|
SyncContext | context | SyncContext instance. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<ItemMetadata> | Changed bpm'online entities ItemMetadata. |
FindItemMetaData(String)
Returns ItemMetadata instance using remoteItemId
.
Declaration
ItemMetadata FindItemMetaData(string remoteItemId)
Parameters
Type | Name | Description |
---|---|---|
System.String | remoteItemId | Remote item unique id. |
Returns
Type | Description |
---|---|
ItemMetadata | ItemMetadata instance. |
TryResolveExtraParameters(Guid, out String)
Returns extraParameters
, using localId
.
Declaration
bool TryResolveExtraParameters(Guid localId, out string extraParameters)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | localId | Bpm'online entity Id. |
System.String | extraParameters | Remote item extra parameters. |
Returns
Type | Description |
---|---|
System.Boolean | True, if |
TryResolveRemoteId(Guid, String, out String)
Returns remoteId
, using localId
.
If item was marked as deleted in bpm'online, remoteId
will not be returned.
Declaration
bool TryResolveRemoteId(Guid localId, string remoteItemName, out string remoteId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | localId | Bpm'online entity Id. |
System.String | remoteItemName | Remote storage item name. |
System.String | remoteId | Remote storage item id. |
Returns
Type | Description |
---|---|
System.Boolean | True, if |
TryResolveRemoteId(Guid, out String)
Returns remoteId
, using bpm'online localId
.
If item was marked as deleted in bpm'online, remoteId
will not be returned.
Declaration
bool TryResolveRemoteId(Guid localId, out string remoteId)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | localId | Bpm'online entity Id. |
System.String | remoteId | Remote storage item id. |
Returns
Type | Description |
---|---|
System.Boolean | True, if |
UpdateItemMetadata(ItemMetadata, IRemoteItem, LocalItem, Boolean, SyncContext)
Updates sync metadata after item synchronization.
Declaration
void UpdateItemMetadata(ItemMetadata oldItemMetaDatas, IRemoteItem remoteItem, LocalItem localItem, bool changesToBpm, SyncContext context = null)
Parameters
Type | Name | Description |
---|---|---|
ItemMetadata | oldItemMetaDatas | Metadata instance from previous synchronization. |
IRemoteItem | remoteItem | Remote item instance. |
LocalItem | localItem | Local item instance. |
System.Boolean | changesToBpm | Current synchronization direction. |
SyncContext | context | SyncContext instance. |