Class QuoteConnection

Represent one connection to an ERP system and uses an IQuoteConnector implementation (the real connection) and an SuperOffice.CRM.Sale.QuoteConnectorMediator to wrap the real connection. Has a connection to the CRM database too, and gets data from it when needed.

Inheritance
Object
QuoteConnection
Inherited Members
Namespace: SuperOffice.CRM
Assembly: SoDataBase.dll
Syntax
public class QuoteConnection

Constructors

QuoteConnection(QuoteConnectionRow, Int32[], Int32[], Dictionary<String, String>, UserInfo, Boolean)

Create a QuoteConnection from information in the database. Used by the QuoteConnectionManager to create instances from the database information.

Declaration
public QuoteConnection(QuoteConnectionRow quoteConnectionRow, int[] associateAccesIds, int[] usergroupAccesIds, Dictionary<string, string> connectionConfigFieldInfos, UserInfo user, bool isOnTravel)
Parameters
Type Name Description
QuoteConnectionRow quoteConnectionRow
Int32[] associateAccesIds
Int32[] usergroupAccesIds
Dictionary<String, String> connectionConfigFieldInfos
UserInfo user
Boolean isOnTravel

QuoteConnection(String)

Create a connection without a database record.

Declaration
public QuoteConnection(string connectorName)
Parameters
Type Name Description
String connectorName

Name of the IQuoteConnector plugin

Properties

AllAccess

Is this connection accessible to everyone? If not, then the QuoteConnectionAccess table tells us who can access it. UserGroupAccessIds and/or AssociateAccessIds should be filled in if this value is false.

Declaration
public bool AllAccess { get; set; }
Property Value
Type Description
Boolean

AssociateAccessIds

Array of ids containing associates that will have access to this connection.

Declaration
public int[] AssociateAccessIds { get; set; }
Property Value
Type Description
Int32[]

Connector

Returns the QuoteConnectorMediator that wraps the real connector. May return NULL if the connector is not available.

Declaration
public IQuoteConnector Connector { get; }
Property Value
Type Description
IQuoteConnector

ConnectorName

Name of the connector we are going to use.

Declaration
public string ConnectorName { get; set; }
Property Value
Type Description
String

CRMConnectionId

Declaration
public int CRMConnectionId { get; set; }
Property Value
Type Description
Int32

Deleted

Has the connection been deleted?

Declaration
public bool Deleted { get; set; }
Property Value
Type Description
Boolean

DisplayDescription

Declaration
public string DisplayDescription { get; set; }
Property Value
Type Description
String

DisplayName

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
String

ErpConnectionId

Declaration
public int ErpConnectionId { get; set; }
Property Value
Type Description
Int32

ERPName

Declaration
public string ERPName { get; set; }
Property Value
Type Description
String

ExtraData

Declaration
public string ExtraData { get; set; }
Property Value
Type Description
String

InitializeResponse

What happened when we tried to initialize connector? NULL if the connector has not been initialized yet.

Declaration
public PluginResponseInfo InitializeResponse { get; }
Property Value
Type Description
PluginResponseInfo

IsAvailable

Is the connection available for use, or is the connection missing something? False if the Initialization of the connector failed.

Declaration
public bool IsAvailable { get; set; }
Property Value
Type Description
Boolean

Rank

The connections rank.

Declaration
public int Rank { get; set; }
Property Value
Type Description
Int32

UserGroupAccessIds

Array of ids containing usergroups that will have access to this connection.

Declaration
public int[] UserGroupAccessIds { get; set; }
Property Value
Type Description
Int32[]

Methods

CheckLicensesFor(IQuoteConnector)

Declaration
public static IQuoteConnector CheckLicensesFor(IQuoteConnector connector)
Parameters
Type Name Description
IQuoteConnector connector
Returns
Type Description
IQuoteConnector

Initialize()

On-demand initialization of connection

Declaration
public PluginResponseInfo Initialize()
Returns
Type Description
PluginResponseInfo

Initialize(Dictionary<String, String>, UserInfo, Boolean)

Create a new connection and initialize the connection if neccessary. Subsequent calls have not effect.

Declaration
public PluginResponseInfo Initialize(Dictionary<string, string> connectionConfigFieldInfos, UserInfo user, bool isOnTravel)
Parameters
Type Name Description
Dictionary<String, String> connectionConfigFieldInfos
UserInfo user
Boolean isOnTravel
Returns
Type Description
PluginResponseInfo

SuperOffice.CRM.Sale.QuoteConnectorMediator wrapping the real connection

ToString()

Default toString returning CRMConnectionId, DisplayName and ConnectorName

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Extension Methods

EnumUtil.MapEnums<From, To>(From)