Class NSQuoteConnection

Information about a connection to the ERP system.

Syntax

Constructors

NSQuoteConnection()

Initializes a new instance of the NSQuoteConnection class.

Declaration

NSQuoteConnection

Methods

GetAllAccess()

Information about a connection to the ERP system.

Declaration

Bool GetAllAccess()

Returns

Type	Description
Bool	Is this connection accessible to everyone? If not, then the QuoteConnectionAccess table tells us who can access it.

Examples

NSQuoteConnection thing;
Bool allAccess = thing.GetAllAccess();

GetAssociateAccessIds()

Information about a connection to the ERP system.

Declaration

Integer[] GetAssociateAccessIds()

Returns

Type	Description
Integer[]	Array of IDs containing associates that will have access to this connection.

Examples

NSQuoteConnection thing;
Integer[] associateAccessIds = thing.GetAssociateAccessIds();

GetConnectorName()

Information about a connection to the ERP system.

Declaration

String GetConnectorName()

Returns

Type	Description
String	Programmatic name of the Connector plugin that implements this kind of connection.

Examples

NSQuoteConnection thing;
String connectorName = thing.GetConnectorName();

GetDeleted()

Information about a connection to the ERP system.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	If set, then this is a row that has been 'deleted'; we do not physically delete rows to avoid disaster.

Examples

NSQuoteConnection thing;
Bool deleted = thing.GetDeleted();

GetDisplayDescription()

Information about a connection to the ERP system.

Declaration

String GetDisplayDescription()

Returns

Type	Description
String	Tooltip/description shown to user; multi-language support. Any other info available that would make an uncertain user chose the right connector. Typically, used for tooltip.

Examples

NSQuoteConnection thing;
String displayDescription = thing.GetDisplayDescription();

GetDisplayName()

Information about a connection to the ERP system.

Declaration

String GetDisplayName()

Returns

Type	Description
String	Connection name shown to user; multi-language support. The name of the connector to display in a list so that the users can choose between them. Typically the name of the client, with maybe the ERP system in parenthesis.

Examples

NSQuoteConnection thing;
String displayName = thing.GetDisplayName();

GetErpConnectionId()

Information about a connection to the ERP system.

Declaration

Integer GetErpConnectionId()

Returns

Type	Description
Integer	The ERP Connection that this Quote connection is an extension of.

Examples

NSQuoteConnection thing;
Integer erpConnectionId = thing.GetErpConnectionId();

GetERPName()

Information about a connection to the ERP system.

Declaration

String GetERPName()

Returns

Type	Description
String	Name of the ERP system (programmatic).

Examples

NSQuoteConnection thing;
String eRPName = thing.GetERPName();

GetExtraData()

Information about a connection to the ERP system.

Declaration

String GetExtraData()

Returns

Type	Description
String	Optional extra data, in XML format, for configuring the connector. Connector-specific!

Examples

NSQuoteConnection thing;
String extraData = thing.GetExtraData();

GetInitializeResponse()

Information about a connection to the ERP system.

Declaration

NSPluginResponse GetInitializeResponse()

Returns

Type	Description
NSPluginResponse	Status and Error message when the system called the connector Initialize method. Null if the connector has not been initialized yet.

Examples

NSQuoteConnection thing;
NSPluginResponse initializeResponse = thing.GetInitializeResponse();

GetIsAvailable()

Information about a connection to the ERP system.

Declaration

Bool GetIsAvailable()

Returns

Type	Description
Bool	Whether or not the specified connection is available. Typically, without network access the availability is false.

Examples

NSQuoteConnection thing;
Bool isAvailable = thing.GetIsAvailable();

GetPriceLists()

Information about a connection to the ERP system.

Declaration

NSPriceList[] GetPriceLists()

Returns

Type	Description
NSPriceList[]	The PriceLists that this connection offers.

Examples

NSQuoteConnection thing;
NSPriceList[] priceLists = thing.GetPriceLists();

GetQuoteConnectionId()

Information about a connection to the ERP system.

Declaration

Integer GetQuoteConnectionId()

Returns

Type	Description
Integer	Primary key.

Examples

NSQuoteConnection thing;
Integer quoteConnectionId = thing.GetQuoteConnectionId();

GetRank()

Information about a connection to the ERP system.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

NSQuoteConnection thing;
Integer rank = thing.GetRank();

GetUserGroupAccessIds()

Information about a connection to the ERP system.

Declaration

Integer[] GetUserGroupAccessIds()

Returns

Type	Description
Integer[]	Array of ids containing user groups that will have access to this connection.

Examples

NSQuoteConnection thing;
Integer[] userGroupAccessIds = thing.GetUserGroupAccessIds();

SetAllAccess(Bool)

Information about a connection to the ERP system.

Declaration

Void SetAllAccess(Bool allAccess)

Parameters

Type	Name	Description
Bool	allAccess	Is this connection accessible to everyone? If not, then the QuoteConnectionAccess table tells us who can access it.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Bool allAccess;
thing.SetAllAccess(allAccess);

SetAssociateAccessIds(Integer[])

Information about a connection to the ERP system.

Declaration

Void SetAssociateAccessIds(Integer[] associateAccessIds)

Parameters

Type	Name	Description
Integer[]	associateAccessIds	Array of IDs containing associates that will have access to this connection.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Integer[] associateAccessIds;
thing.SetAssociateAccessIds(associateAccessIds);

SetConnectorName(String)

Information about a connection to the ERP system.

Declaration

Void SetConnectorName(String connectorName)

Parameters

Type	Name	Description
String	connectorName	Programmatic name of the Connector plugin that implements this kind of connection.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
String connectorName;
thing.SetConnectorName(connectorName);

SetDeleted(Bool)

Information about a connection to the ERP system.

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	If set, then this is a row that has been 'deleted'; we do not physically delete rows to avoid disaster.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Bool deleted;
thing.SetDeleted(deleted);

SetDisplayDescription(String)

Information about a connection to the ERP system.

Declaration

Void SetDisplayDescription(String displayDescription)

Parameters

Type	Name	Description
String	displayDescription	Tooltip/description shown to user; multi-language support. Any other info available that would make an uncertain user chose the right connector. Typically, used for tooltip.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
String displayDescription;
thing.SetDisplayDescription(displayDescription);

SetDisplayName(String)

Information about a connection to the ERP system.

Declaration

Void SetDisplayName(String displayName)

Parameters

Type	Name	Description
String	displayName	Connection name shown to user; multi-language support. The name of the connector to display in a list so that the users can choose between them. Typically the name of the client, with maybe the ERP system in parenthesis.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
String displayName;
thing.SetDisplayName(displayName);

SetErpConnectionId(Integer)

Information about a connection to the ERP system.

Declaration

Void SetErpConnectionId(Integer erpConnectionId)

Parameters

Type	Name	Description
Integer	erpConnectionId	The ERP Connection that this Quote connection is an extension of.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Integer erpConnectionId;
thing.SetErpConnectionId(erpConnectionId);

SetERPName(String)

Information about a connection to the ERP system.

Declaration

Void SetERPName(String eRPName)

Parameters

Type	Name	Description
String	eRPName	Name of the ERP system (programmatic).

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
String eRPName;
thing.SetERPName(eRPName);

SetExtraData(String)

Information about a connection to the ERP system.

Declaration

Void SetExtraData(String extraData)

Parameters

Type	Name	Description
String	extraData	Optional extra data, in XML format, for configuring the connector. Connector-specific!

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
String extraData;
thing.SetExtraData(extraData);

SetInitializeResponse(NSPluginResponse)

Information about a connection to the ERP system.

Declaration

Void SetInitializeResponse(NSPluginResponse initializeResponse)

Parameters

Type	Name	Description
NSPluginResponse	initializeResponse	Status and Error message when the system called the connector Initialize method. Null if the connector has not been initialized yet.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
NSPluginResponse initializeResponse;
thing.SetInitializeResponse(initializeResponse);

SetIsAvailable(Bool)

Whether or not the specified connection is available. Typically, without network access the availability is false.

Declaration

Void SetIsAvailable(Bool isAvailable)

Parameters

Type	Name	Description
Bool	isAvailable

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Bool isAvailable;
thing.SetIsAvailable(isAvailable);

SetPriceLists(NSPriceList[])

Information about a connection to the ERP system.

Declaration

Void SetPriceLists(NSPriceList[] priceLists)

Parameters

Type	Name	Description
NSPriceList[]	priceLists	The PriceLists that this connection offers.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
NSPriceList[] priceLists;
thing.SetPriceLists(priceLists);

SetQuoteConnectionId(Integer)

Information about a connection to the ERP system.

Declaration

Void SetQuoteConnectionId(Integer quoteConnectionId)

Parameters

Type	Name	Description
Integer	quoteConnectionId	Primary key.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Integer quoteConnectionId;
thing.SetQuoteConnectionId(quoteConnectionId);

SetRank(Integer)

Information about a connection to the ERP system.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank order.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Integer rank;
thing.SetRank(rank);

SetUserGroupAccessIds(Integer[])

Information about a connection to the ERP system.

Declaration

Void SetUserGroupAccessIds(Integer[] userGroupAccessIds)

Parameters

Type	Name	Description
Integer[]	userGroupAccessIds	Array of ids containing user groups that will have access to this connection.

Returns

Type	Description
Void

Examples

NSQuoteConnection thing;
Integer[] userGroupAccessIds;
thing.SetUserGroupAccessIds(userGroupAccessIds);