Class NSSaleTypeEntity

Syntax

Constructors

NSSaleTypeEntity()

Initializes a new instance of the NSSaleTypeEntity class.

Declaration

NSSaleTypeEntity

Methods

GetAllowQuoteAlternatives()

Declaration

Bool GetAllowQuoteAlternatives()

Returns

Type	Description
Bool	Can quotes linked to sales of this type, have multiple Alternatives.

Examples

NSSaleTypeEntity thing;
Bool allowQuoteAlternatives = thing.GetAllowQuoteAlternatives();

GetConfirmationLinesTemplate()

Declaration

Integer GetConfirmationLinesTemplate()

Returns

Type	Description
Integer	The template that this sale type should use when producing the order confirmation lines document; the template must have DocTmplQuoteType=ConfirmationLines.

Examples

NSSaleTypeEntity thing;
Integer confirmationLinesTemplate = thing.GetConfirmationLinesTemplate();

GetDefaultQuoteValidity()

Declaration

Integer GetDefaultQuoteValidity()

Returns

Type	Description
Integer	Default valid days for quotes linked to sales of this type (valid from quote transmission).

Examples

NSSaleTypeEntity thing;
Integer defaultQuoteValidity = thing.GetDefaultQuoteValidity();

GetDeleted()

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	0 -> record is active 1 -> record is 'deleted' and should not be shown in lists.

Examples

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

GetDurationUnit()

Declaration

Integer GetDurationUnit()

Returns

Type	Description
Integer	Units for the duration (day, week, whatever). See DurationUnit.

Examples

NSSaleTypeEntity thing;
Integer durationUnit = thing.GetDurationUnit();

GetGroupQuoteLinesBy()

Declaration

Integer GetGroupQuoteLinesBy()

Returns

Type	Description
Integer	Group quote lines by this field.

Examples

NSSaleTypeEntity thing;
Integer groupQuoteLinesBy = thing.GetGroupQuoteLinesBy();

GetHasGuide()

Declaration

Bool GetHasGuide()

Returns

Type	Description
Bool	Does this sale type have a guide attached.

Examples

NSSaleTypeEntity thing;
Bool hasGuide = thing.GetHasGuide();

GetHasStakeholders()

Declaration

Bool GetHasStakeholders()

Returns

Type	Description
Bool	Does this sale type have stakeholders.

Examples

NSSaleTypeEntity thing;
Bool hasStakeholders = thing.GetHasStakeholders();

GetIsAutoAdvance()

Declaration

Bool GetIsAutoAdvance()

Returns

Type	Description
Bool	Does the sale stage advance automatically, when the last guided activity in a stage is completed?

Examples

NSSaleTypeEntity thing;
Bool isAutoAdvance = thing.GetIsAutoAdvance();

GetMaxDiscountPercent()

Declaration

Integer GetMaxDiscountPercent()

Returns

Type	Description
Integer	The maximum discount in percent of total, if set, on quotes linked to sales of this type.

Examples

NSSaleTypeEntity thing;
Integer maxDiscountPercent = thing.GetMaxDiscountPercent();

GetMaxDiscountPercentSet()

Declaration

Bool GetMaxDiscountPercentSet()

Returns

Type	Description
Bool	Is there a limit, in percent, to the total discount on quotes linked to sales of this type.

Examples

NSSaleTypeEntity thing;
Bool maxDiscountPercentSet = thing.GetMaxDiscountPercentSet();

GetMinEarningPercent()

Declaration

Integer GetMinEarningPercent()

Returns

Type	Description
Integer	The minimum earning in percent of total, if set, on quotes linked to sales of this type.

Examples

NSSaleTypeEntity thing;
Integer minEarningPercent = thing.GetMinEarningPercent();

GetMinEarningPercentSet()

Declaration

Bool GetMinEarningPercentSet()

Returns

Type	Description
Bool	Is there a limit, in earning as percent of total, on quotes linked to sales of this type.

Examples

NSSaleTypeEntity thing;
Bool minEarningPercentSet = thing.GetMinEarningPercentSet();

GetName()

Declaration

String GetName()

Returns

Type	Description
String	The list item.

Examples

NSSaleTypeEntity thing;
String name = thing.GetName();

GetQuoteLinesTemplate()

Declaration

Integer GetQuoteLinesTemplate()

Returns

Type	Description
Integer	The template that this sale type should use when producing the product lines offer document; the template must have DocTmplQuoteType=QuoteLines.

Examples

NSSaleTypeEntity thing;
Integer quoteLinesTemplate = thing.GetQuoteLinesTemplate();

GetRank()

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

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

GetSaleDuration()

Declaration

Integer GetSaleDuration()

Returns

Type	Description
Integer	Expected number of dales from initiation to close of sale.

Examples

NSSaleTypeEntity thing;
Integer saleDuration = thing.GetSaleDuration();

GetSaleTypeCatId()

Declaration

Integer GetSaleTypeCatId()

Returns

Type	Description
Integer	Category of sale type, copied to sale.

Examples

NSSaleTypeEntity thing;
Integer saleTypeCatId = thing.GetSaleTypeCatId();

GetSaleTypeId()

Declaration

Integer GetSaleTypeId()

Returns

Type	Description
Integer	Primary key.

Examples

NSSaleTypeEntity thing;
Integer saleTypeId = thing.GetSaleTypeId();

GetSortGroupLinesBy()

Declaration

Integer GetSortGroupLinesBy()

Returns

Type	Description
Integer	Sort group lines by this field.

Examples

NSSaleTypeEntity thing;
Integer sortGroupLinesBy = thing.GetSortGroupLinesBy();

GetStages()

Declaration

NSSelectableMDOListItem[] GetStages()

Returns

Type	Description
NSSelectableMDOListItem[]	Stages, those associated with this NSSaleType are selected.

Examples

NSSaleTypeEntity thing;
NSSelectableMDOListItem[] stages = thing.GetStages();

GetTooltip()

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip or other description.

Examples

NSSaleTypeEntity thing;
String tooltip = thing.GetTooltip();

SetAllowQuoteAlternatives(Bool)

Declaration

Void SetAllowQuoteAlternatives(Bool allowQuoteAlternatives)

Parameters

Type	Name	Description
Bool	allowQuoteAlternatives	Can quotes linked to sales of this type, have multiple Alternatives.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Bool allowQuoteAlternatives;
thing.SetAllowQuoteAlternatives(allowQuoteAlternatives);

SetConfirmationLinesTemplate(Integer)

Declaration

Void SetConfirmationLinesTemplate(Integer confirmationLinesTemplate)

Parameters

Type	Name	Description
Integer	confirmationLinesTemplate	The template that this sale type should use when producing the order confirmation lines document; the template must have DocTmplQuoteType=ConfirmationLines.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer confirmationLinesTemplate;
thing.SetConfirmationLinesTemplate(confirmationLinesTemplate);

SetDefaultQuoteValidity(Integer)

Declaration

Void SetDefaultQuoteValidity(Integer defaultQuoteValidity)

Parameters

Type	Name	Description
Integer	defaultQuoteValidity	Default valid days for quotes linked to sales of this type (valid from quote transmission).

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer defaultQuoteValidity;
thing.SetDefaultQuoteValidity(defaultQuoteValidity);

SetDeleted(Bool)

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	0 -> record is active 1 -> record is 'deleted' and should not be shown in lists.

Returns

Type	Description
Void

Examples

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

SetDurationUnit(Integer)

Declaration

Void SetDurationUnit(Integer durationUnit)

Parameters

Type	Name	Description
Integer	durationUnit	Units for the duration (day, week, whatever) See DurationUnit.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer durationUnit;
thing.SetDurationUnit(durationUnit);

SetGroupQuoteLinesBy(Integer)

Declaration

Void SetGroupQuoteLinesBy(Integer groupQuoteLinesBy)

Parameters

Type	Name	Description
Integer	groupQuoteLinesBy	Group quote lines by this field.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer groupQuoteLinesBy;
thing.SetGroupQuoteLinesBy(groupQuoteLinesBy);

SetHasGuide(Bool)

Declaration

Void SetHasGuide(Bool hasGuide)

Parameters

Type	Name	Description
Bool	hasGuide	Does this sale type have a guide attached.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Bool hasGuide;
thing.SetHasGuide(hasGuide);

SetHasStakeholders(Bool)

Declaration

Void SetHasStakeholders(Bool hasStakeholders)

Parameters

Type	Name	Description
Bool	hasStakeholders	Does this sale type have stakeholders.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Bool hasStakeholders;
thing.SetHasStakeholders(hasStakeholders);

SetIsAutoAdvance(Bool)

Declaration

Void SetIsAutoAdvance(Bool isAutoAdvance)

Parameters

Type	Name	Description
Bool	isAutoAdvance	Does the sale stage advance automatically, when the last guided activity in a stage is completed?

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Bool isAutoAdvance;
thing.SetIsAutoAdvance(isAutoAdvance);

SetMaxDiscountPercent(Integer)

Declaration

Void SetMaxDiscountPercent(Integer maxDiscountPercent)

Parameters

Type	Name	Description
Integer	maxDiscountPercent	The maximum discount in percent of total, if set, on quotes linked to sales of this type.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer maxDiscountPercent;
thing.SetMaxDiscountPercent(maxDiscountPercent);

SetMaxDiscountPercentSet(Bool)

Declaration

Void SetMaxDiscountPercentSet(Bool maxDiscountPercentSet)

Parameters

Type	Name	Description
Bool	maxDiscountPercentSet	Is there a limit, in percent, to the total discount on quotes linked to sales of this type.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Bool maxDiscountPercentSet;
thing.SetMaxDiscountPercentSet(maxDiscountPercentSet);

SetMinEarningPercent(Integer)

Declaration

Void SetMinEarningPercent(Integer minEarningPercent)

Parameters

Type	Name	Description
Integer	minEarningPercent	The minimum earning in percent of total, if set, on quotes linked to sales of this type.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer minEarningPercent;
thing.SetMinEarningPercent(minEarningPercent);

SetMinEarningPercentSet(Bool)

Declaration

Void SetMinEarningPercentSet(Bool minEarningPercentSet)

Parameters

Type	Name	Description
Bool	minEarningPercentSet	Is there a limit, in earning as percent of total, on quotes linked to sales of this type.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Bool minEarningPercentSet;
thing.SetMinEarningPercentSet(minEarningPercentSet);

SetName(String)

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The list item.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
String name;
thing.SetName(name);

SetQuoteLinesTemplate(Integer)

Declaration

Void SetQuoteLinesTemplate(Integer quoteLinesTemplate)

Parameters

Type	Name	Description
Integer	quoteLinesTemplate	The template that this sale type should use when producing the product lines offer document; the template must have DocTmplQuoteType=QuoteLines.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer quoteLinesTemplate;
thing.SetQuoteLinesTemplate(quoteLinesTemplate);

SetRank(Integer)

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank order.

Returns

Type	Description
Void

Examples

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

SetSaleDuration(Integer)

Declaration

Void SetSaleDuration(Integer saleDuration)

Parameters

Type	Name	Description
Integer	saleDuration	Expected number of dales from initiation to close of sale.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer saleDuration;
thing.SetSaleDuration(saleDuration);

SetSaleTypeCatId(Integer)

Declaration

Void SetSaleTypeCatId(Integer saleTypeCatId)

Parameters

Type	Name	Description
Integer	saleTypeCatId	Category of sale type, copied to sale.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer saleTypeCatId;
thing.SetSaleTypeCatId(saleTypeCatId);

SetSaleTypeId(Integer)

Declaration

Void SetSaleTypeId(Integer saleTypeId)

Parameters

Type	Name	Description
Integer	saleTypeId	Primary key.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer saleTypeId;
thing.SetSaleTypeId(saleTypeId);

SetSortGroupLinesBy(Integer)

Declaration

Void SetSortGroupLinesBy(Integer sortGroupLinesBy)

Parameters

Type	Name	Description
Integer	sortGroupLinesBy	Sort group lines by this field.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
Integer sortGroupLinesBy;
thing.SetSortGroupLinesBy(sortGroupLinesBy);

SetStages(NSSelectableMDOListItem[])

Declaration

Void SetStages(NSSelectableMDOListItem[] stages)

Parameters

Type	Name	Description
NSSelectableMDOListItem[]	stages	Stages, those associated with this NSSaleType are selected.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
NSSelectableMDOListItem[] stages;
thing.SetStages(stages);

SetTooltip(String)

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Tooltip or other description.

Returns

Type	Description
Void

Examples

NSSaleTypeEntity thing;
String tooltip;
thing.SetTooltip(tooltip);