Class ErpSyncListsProvider

Wildcard list provider for ERP Integration lists; see remarks for naming conventions

Inheritance

object

ErpSyncListsProvider

Implements

IWildcardMDOProvider

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: SuperOffice.CRM.Lists

Assembly: SuperOffice.Services.Implementation.dll

Syntax

public sealed class ErpSyncListsProvider : IWildcardMDOProvider

Remarks

ErpSync lists, supplied by the ErpSync connectors, adhere to the following naming convention:
If the list is named 'PaymentTerms', and the context is that we have an ErpConnection with id 5, then the list name EIS_5_PaymentTerms will retrieve the correct list via the correct connector.

The first part must be uppercase ERPSYNC, the second part must be a valid ErpConnectionId, and the third part must be a list name recognized by the connector. Underscore is the delimiter character.

If the call fails for any reason, then an empty list is returned. Only flat lists are supported by this mechanism.

Constructors

ErpSyncListsProvider()

Wildcard list provider for ERP Integration lists; see remarks for naming conventions

Declaration

public ErpSyncListsProvider()

Remarks

ErpSync lists, supplied by the ErpSync connectors, adhere to the following naming convention:
If the list is named 'PaymentTerms', and the context is that we have an ErpConnection with id 5, then the list name EIS_5_PaymentTerms will retrieve the correct list via the correct connector.

The first part must be uppercase ERPSYNC, the second part must be a valid ErpConnectionId, and the third part must be a list name recognized by the connector. Underscore is the delimiter character.

If the call fails for any reason, then an empty list is returned. Only flat lists are supported by this mechanism.

Fields

Prefix

Wildcard list provider for ERP Integration lists; see remarks for naming conventions

Declaration

public const string Prefix = "ERPSYNC"

Field Value

Type	Description
string

Remarks

ErpSync lists, supplied by the ErpSync connectors, adhere to the following naming convention:
If the list is named 'PaymentTerms', and the context is that we have an ErpConnection with id 5, then the list name EIS_5_PaymentTerms will retrieve the correct list via the correct connector.

The first part must be uppercase ERPSYNC, the second part must be a valid ErpConnectionId, and the third part must be a list name recognized by the connector. Underscore is the delimiter character.

If the call fails for any reason, then an empty list is returned. Only flat lists are supported by this mechanism.

Methods

GetListName(string, int)

Given a base list name and erp connection id, return the list name that uniquely specifies the "real" list name that can be used all over the place

Declaration

public static string GetListName(string name, int erpConnectionId)

Parameters

Type	Name	Description
string	name
int	erpConnectionId

Returns

Type	Description
string

Remarks

ErpSync lists, supplied by the ErpSync connectors, adhere to the following naming convention:
If the list is named 'PaymentTerms', and the context is that we have an ErpConnection with id 5, then the list name EIS_5_PaymentTerms will retrieve the correct list via the correct connector.

The first part must be uppercase ERPSYNC, the second part must be a valid ErpConnectionId, and the third part must be a list name recognized by the connector. Underscore is the delimiter character.

If the call fails for any reason, then an empty list is returned. Only flat lists are supported by this mechanism.

GetProviderAsync(string, CancellationToken)

Return a fully populated, concrete list provider for a given list name; or null. See class remarks for more information.

Declaration

public Task<ISoListProvider> GetProviderAsync(string listName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	listName
CancellationToken	cancellationToken

Returns

Type	Description
Task<ISoListProvider>

Remarks

ErpSync lists, supplied by the ErpSync connectors, adhere to the following naming convention:
If the list is named 'PaymentTerms', and the context is that we have an ErpConnection with id 5, then the list name EIS_5_PaymentTerms will retrieve the correct list via the correct connector.

The first part must be uppercase ERPSYNC, the second part must be a valid ErpConnectionId, and the third part must be a list name recognized by the connector. Underscore is the delimiter character.

If the call fails for any reason, then an empty list is returned. Only flat lists are supported by this mechanism.

Implements

SuperOffice.CRM.Lists.IWildcardMDOProvider