Show / Hide Table of Contents

Class NSPriceList

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Syntax

Constructors

NSPriceList()

Initializes a new instance of the NSPriceList class.

Declaration
NSPriceList

Methods

GetCurrency()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
String GetCurrency()
Returns
Type Description
String

The iso currency code, like 'USD' or 'NOK'.

Examples
NSPriceList thing;
String currency = thing.GetCurrency();

GetCurrencyName()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
String GetCurrencyName()
Returns
Type Description
String

The name to use in the user interface, like perhaps 'US dollar' or '$'.

Examples
NSPriceList thing;
String currencyName = thing.GetCurrencyName();

GetDescription()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
String GetDescription()
Returns
Type Description
String

Description of this price list, will be used as tool-tip in the user interface.

Examples
NSPriceList thing;
String description = thing.GetDescription();

GetERPPriceListKey()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
String GetERPPriceListKey()
Returns
Type Description
String

The key that uniquely identifies this price list in the ERP system.

Examples
NSPriceList thing;
String eRPPriceListKey = thing.GetERPPriceListKey();

GetIsActive()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Bool GetIsActive()
Returns
Type Description
Bool

Is the list active (as opposed to being worked on, suddenly canceled, etc.

Examples
NSPriceList thing;
Bool isActive = thing.GetIsActive();

GetName()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
String GetName()
Returns
Type Description
String

Name of this price list to use in the user interface.

Examples
NSPriceList thing;
String name = thing.GetName();

GetPriceListId()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Integer GetPriceListId()
Returns
Type Description
Integer

Primary key.

Examples
NSPriceList thing;
Integer priceListId = thing.GetPriceListId();

GetQuoteConnectionId()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Integer GetQuoteConnectionId()
Returns
Type Description
Integer

The connection to the ERP system used for this price list.

Remarks

Reserved for future use

Examples
NSPriceList thing;
Integer quoteConnectionId = thing.GetQuoteConnectionId();

GetValidFrom()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
DateTime GetValidFrom()
Returns
Type Description
DateTime

The date (inclusive) the price list start to be valid. This can be DateTime.MinValue to signal that it doesn't have a specific start date.

Examples
NSPriceList thing;
DateTime validFrom = thing.GetValidFrom();

GetValidTo()

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
DateTime GetValidTo()
Returns
Type Description
DateTime

The date (inclusive) the price list ends to be valid. This can be DateTime.MaxValue to signal that it doesn't have a specific end date.

Examples
NSPriceList thing;
DateTime validTo = thing.GetValidTo();

SetCurrency(String)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetCurrency(String currency)
Parameters
Type Name Description
String currency

The iso currency code, like 'USD' or 'NOK'.

Returns
Type Description
Void
Examples
NSPriceList thing;
String currency;
thing.SetCurrency(currency);

SetCurrencyName(String)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetCurrencyName(String currencyName)
Parameters
Type Name Description
String currencyName

The name to use in the user interface, like perhaps 'US dollar' or '$'.

Returns
Type Description
Void
Examples
NSPriceList thing;
String currencyName;
thing.SetCurrencyName(currencyName);

SetDescription(String)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetDescription(String description)
Parameters
Type Name Description
String description

Description of this price list, will be used as tool-tip in the user interface.

Returns
Type Description
Void
Examples
NSPriceList thing;
String description;
thing.SetDescription(description);

SetERPPriceListKey(String)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetERPPriceListKey(String eRPPriceListKey)
Parameters
Type Name Description
String eRPPriceListKey

The key that uniquely identifies this price list in the ERP system.

Returns
Type Description
Void
Examples
NSPriceList thing;
String eRPPriceListKey;
thing.SetERPPriceListKey(eRPPriceListKey);

SetIsActive(Bool)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetIsActive(Bool isActive)
Parameters
Type Name Description
Bool isActive

Is the list active (as opposed to being worked on, suddenly canceled, etc.

Returns
Type Description
Void
Examples
NSPriceList thing;
Bool isActive;
thing.SetIsActive(isActive);

SetName(String)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

Name of this price list to use in the user interface.

Returns
Type Description
Void
Examples
NSPriceList thing;
String name;
thing.SetName(name);

SetPriceListId(Integer)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetPriceListId(Integer priceListId)
Parameters
Type Name Description
Integer priceListId

Primary key.

Returns
Type Description
Void
Examples
NSPriceList thing;
Integer priceListId;
thing.SetPriceListId(priceListId);

SetQuoteConnectionId(Integer)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetQuoteConnectionId(Integer quoteConnectionId)
Parameters
Type Name Description
Integer quoteConnectionId

The connection to the ERP system used for this price list.

Returns
Type Description
Void
Remarks

Reserved for future use

Examples
NSPriceList thing;
Integer quoteConnectionId;
thing.SetQuoteConnectionId(quoteConnectionId);

SetValidFrom(DateTime)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetValidFrom(DateTime validFrom)
Parameters
Type Name Description
DateTime validFrom

The date (inclusive) the price list start to be valid. This can be DateTime.MinValue to signal that it doesn't have a specific start date.

Returns
Type Description
Void
Examples
NSPriceList thing;
DateTime validFrom;
thing.SetValidFrom(validFrom);

SetValidTo(DateTime)

A price list is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Declaration
Void SetValidTo(DateTime validTo)
Parameters
Type Name Description
DateTime validTo

The date (inclusive) the price list ends to be valid. This can be DateTime.MaxValue to signal that it doesn't have a specific end date.

Returns
Type Description
Void
Examples
NSPriceList thing;
DateTime validTo;
thing.SetValidTo(validTo);
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top