Class NSQuoteConnection
Information about a connection to the ERP system.
Constructors
NSQuoteConnection()
Initializes a new instance of the NSQuoteConnection class.
Declaration
NSQuoteConnectionMethods
GetAllAccess()
Declaration
Bool GetAllAccess()Examples
NSQuoteConnection thing;
Bool allAccess = thing.GetAllAccess();Returns
| Type | Description |
| Bool | Is this connection accessible to everyone? If not, then the QuoteConnectionAccess table tells us who can access it. |
GetAssociateAccessIds()
Declaration
Integer[] GetAssociateAccessIds()Examples
NSQuoteConnection thing;
Integer[] associateAccessIds = thing.GetAssociateAccessIds();Returns
| Type | Description |
| Integer[] | Array of IDs containing associates that will have access to this connection. |
GetConnectorName()
Declaration
String GetConnectorName()Examples
NSQuoteConnection thing;
String connectorName = thing.GetConnectorName();Returns
| Type | Description |
| String | Programmatic name of the Connector plugin that implements this kind of connection. |
GetDeleted()
Declaration
Bool GetDeleted()Examples
NSQuoteConnection thing;
Bool deleted = thing.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. |
GetDisplayDescription()
Declaration
String GetDisplayDescription()Examples
NSQuoteConnection thing;
String displayDescription = thing.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. |
GetDisplayName()
Declaration
String GetDisplayName()Examples
NSQuoteConnection thing;
String displayName = thing.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. |
GetErpConnectionId()
Declaration
Integer GetErpConnectionId()Examples
NSQuoteConnection thing;
Integer erpConnectionId = thing.GetErpConnectionId();Returns
| Type | Description |
| Integer | The ERP Connection that this Quote connection is an extension of. |
GetERPName()
Declaration
String GetERPName()Examples
NSQuoteConnection thing;
String eRPName = thing.GetERPName();Returns
| Type | Description |
| String | Name of the ERP system (programmatic). |
GetExtraData()
Declaration
String GetExtraData()Examples
NSQuoteConnection thing;
String extraData = thing.GetExtraData();Returns
| Type | Description |
| String | Optional extra data, in XML format, for configuring the connector. Connector-specific! |
GetInitializeResponse()
Declaration
NSPluginResponse GetInitializeResponse()Examples
NSQuoteConnection thing;
NSPluginResponse initializeResponse = thing.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. |
GetIsAvailable()
Declaration
Bool GetIsAvailable()Examples
NSQuoteConnection thing;
Bool isAvailable = thing.GetIsAvailable();Returns
| Type | Description |
| Bool | Whether or not the specified connection is available. Typically, without network access the availability is false. |
GetPriceLists()
Declaration
NSPriceList[] GetPriceLists()Examples
NSQuoteConnection thing;
NSPriceList[] priceLists = thing.GetPriceLists();Returns
| Type | Description |
| NSPriceList[] | The PriceLists that this connection offers. |
GetQuoteConnectionId()
Declaration
Integer GetQuoteConnectionId()Examples
NSQuoteConnection thing;
Integer quoteConnectionId = thing.GetQuoteConnectionId();Returns
| Type | Description |
| Integer | Primary key. |
GetRank()
Declaration
Integer GetRank()Examples
NSQuoteConnection thing;
Integer rank = thing.GetRank();Returns
| Type | Description |
| Integer | Rank order. |
GetUserGroupAccessIds()
Declaration
Integer[] GetUserGroupAccessIds()Examples
NSQuoteConnection thing;
Integer[] userGroupAccessIds = thing.GetUserGroupAccessIds();Returns
| Type | Description |
| Integer[] | Array of ids containing user groups that will have access to this connection. |
SetAllAccess(Bool)
Declaration
Void SetAllAccess(Bool allAccess)Examples
NSQuoteConnection thing;
Bool allAccess;
thing.SetAllAccess(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 |
SetAssociateAccessIds(Integer[])
Declaration
Void SetAssociateAccessIds(Integer[] associateAccessIds)Examples
NSQuoteConnection thing;
Integer[] associateAccessIds;
thing.SetAssociateAccessIds(associateAccessIds);Parameters
| Type | Name | Description |
| Integer[] | associateAccessIds | Array of IDs containing associates that will have access to this connection. |
Returns
| Type | Description |
| Void |
SetConnectorName(String)
Declaration
Void SetConnectorName(String connectorName)Examples
NSQuoteConnection thing;
String connectorName;
thing.SetConnectorName(connectorName);Parameters
| Type | Name | Description |
| String | connectorName | Programmatic name of the Connector plugin that implements this kind of connection. |
Returns
| Type | Description |
| Void |
SetDeleted(Bool)
Declaration
Void SetDeleted(Bool deleted)Examples
NSQuoteConnection thing;
Bool deleted;
thing.SetDeleted(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 |
SetDisplayDescription(String)
Declaration
Void SetDisplayDescription(String displayDescription)Examples
NSQuoteConnection thing;
String displayDescription;
thing.SetDisplayDescription(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 |
SetDisplayName(String)
Declaration
Void SetDisplayName(String displayName)Examples
NSQuoteConnection thing;
String displayName;
thing.SetDisplayName(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 |
SetErpConnectionId(Integer)
Declaration
Void SetErpConnectionId(Integer erpConnectionId)Examples
NSQuoteConnection thing;
Integer erpConnectionId;
thing.SetErpConnectionId(erpConnectionId);Parameters
| Type | Name | Description |
| Integer | erpConnectionId | The ERP Connection that this Quote connection is an extension of. |
Returns
| Type | Description |
| Void |
SetERPName(String)
Declaration
Void SetERPName(String eRPName)Examples
NSQuoteConnection thing;
String eRPName;
thing.SetERPName(eRPName);Parameters
| Type | Name | Description |
| String | eRPName | Name of the ERP system (programmatic). |
Returns
| Type | Description |
| Void |
SetExtraData(String)
Declaration
Void SetExtraData(String extraData)Examples
NSQuoteConnection thing;
String extraData;
thing.SetExtraData(extraData);Parameters
| Type | Name | Description |
| String | extraData | Optional extra data, in XML format, for configuring the connector. Connector-specific! |
Returns
| Type | Description |
| Void |
SetInitializeResponse(NSPluginResponse)
Declaration
Void SetInitializeResponse(NSPluginResponse initializeResponse)Examples
NSQuoteConnection thing;
NSPluginResponse initializeResponse;
thing.SetInitializeResponse(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 |
SetIsAvailable(Bool)
Whether or not the specified connection is available. Typically, without network access the availability is false.
Declaration
Void SetIsAvailable(Bool isAvailable)Examples
NSQuoteConnection thing;
Bool isAvailable;
thing.SetIsAvailable(isAvailable);Parameters
| Type | Name | Description |
| Bool | isAvailable |
Returns
| Type | Description |
| Void |
SetPriceLists(NSPriceList[])
Declaration
Void SetPriceLists(NSPriceList[] priceLists)Examples
NSQuoteConnection thing;
NSPriceList[] priceLists;
thing.SetPriceLists(priceLists);Parameters
| Type | Name | Description |
| NSPriceList[] | priceLists | The PriceLists that this connection offers. |
Returns
| Type | Description |
| Void |
SetQuoteConnectionId(Integer)
Declaration
Void SetQuoteConnectionId(Integer quoteConnectionId)Examples
NSQuoteConnection thing;
Integer quoteConnectionId;
thing.SetQuoteConnectionId(quoteConnectionId);Parameters
| Type | Name | Description |
| Integer | quoteConnectionId | Primary key. |
Returns
| Type | Description |
| Void |
SetRank(Integer)
Declaration
Void SetRank(Integer rank)Examples
NSQuoteConnection thing;
Integer rank;
thing.SetRank(rank);Parameters
| Type | Name | Description |
| Integer | rank | Rank order. |
Returns
| Type | Description |
| Void |
SetUserGroupAccessIds(Integer[])
Declaration
Void SetUserGroupAccessIds(Integer[] userGroupAccessIds)Examples
NSQuoteConnection thing;
Integer[] userGroupAccessIds;
thing.SetUserGroupAccessIds(userGroupAccessIds);Parameters
| Type | Name | Description |
| Integer[] | userGroupAccessIds | Array of ids containing user groups that will have access to this connection. |
Returns
| Type | Description |
| Void |