Class SaleInfoProvider

Implementation of ISaleInfo2; create through factory (see remarks)

Inheritance

object

SaleInfoProvider

Implements

ISaleInfo3

ISaleInfo2

ISaleInfo

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Entities.Providers

Assembly: SoDataBase.dll

Syntax

public class SaleInfoProvider : ISaleInfo3, ISaleInfo2, ISaleInfo

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Properties

Amount

Sale amount

Declaration

public double Amount { get; }

Property Value

Type	Description
double

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Associate

Owner of the sale

Declaration

public string Associate { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

AssociateId

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public int AssociateId { get; }

Property Value

Type	Description
int

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Competitor

Main Competitor for sale - an MDO list item name

Declaration

public string Competitor { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Cost

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public double Cost { get; }

Property Value

Type	Description
double

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

CreatedAssociate

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public string CreatedAssociate { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Credited

Credited to - an MDO list item name

Declaration

public string Credited { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Currency

Sale currency

Declaration

public string Currency { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

CustomFields

UDef fields and extra field values encoded as strings: "x_foo" = "[I:123]", "SuperOffice:1" = "[F:34.56]"

Declaration

public Dictionary<string, string> CustomFields { get; }

Property Value

Type	Description
Dictionary<string, string>

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Earning

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public double Earning { get; }

Property Value

Type	Description
double

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

EarningPercent

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public double EarningPercent { get; }

Property Value

Type	Description
double

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

HasGuide

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public bool HasGuide { get; }

Property Value

Type	Description
bool

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

HasStakeHolders

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public bool HasStakeHolders { get; }

Property Value

Type	Description
bool

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

NextDueDate

Date of the first uncompleted activity.

Declaration

public string NextDueDate { get; }

Property Value

Type	Description
string

Remarks

Assumed to be formatted like "yyyyMMdd"

Number

Sale number

Declaration

public string Number { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Probability

Probability percent - default derived from Stage list item.

Declaration

public short Probability { get; }

Property Value

Type	Description
short

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

PublishActiveDate

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public DateTime PublishActiveDate { get; }

Property Value

Type	Description
DateTime

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

PublishEndDate

Sale, start date for publishing

Declaration

public string PublishEndDate { get; }

Property Value

Type	Description
string

Remarks

Assumed to be formatted like "yyyyMMdd"

PublishStartDate

Sale, end date for publishing

Declaration

public string PublishStartDate { get; }

Property Value

Type	Description
string

Remarks

Assumed to be formatted like "yyyyMMdd"

Reason

Reason the sale is lost/sold etc

Declaration

public string Reason { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Registered

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public string Registered { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Sale

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public Sale Sale { get; }

Property Value

Type	Description
Sale

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

SaleDate

Expected closing date

Declaration

public string SaleDate { get; }

Property Value

Type	Description
string

Remarks

Assumed to be formatted like "yyyyMMdd"

SaleId

Primary key of the sale record

Declaration

public int SaleId { get; }

Property Value

Type	Description
int

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

SaleText

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public string SaleText { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Source

Implementation of ISaleInfo2; create through factory (see remarks)

Declaration

public string Source { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Stage

Sale stage - an MDO list item name

Declaration

public string Stage { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Status

Open/Sold/Lost/Stalled

Declaration

public string Status { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Title

Title of the sale

Declaration

public string Title { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Type

Sale type - an MDO list item name

Declaration

public string Type { get; }

Property Value

Type	Description
string

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Methods

GetUserDefinedDecimal(int)

Return a user defined value of type decimal

Declaration

public string GetUserDefinedDecimal(int fieldNo)

Parameters

Type	Name	Description
int	fieldNo	Index of field to retrieve value for

Returns

Type	Description
string	String representation of the value of specified field

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

GetUserDefinedDecimal(string)

Get the decimal udef value based on the prog.id name of the udef field.

Declaration

public double GetUserDefinedDecimal(string progId)

Parameters

Type	Name	Description
string	progId	Program name of udef field

Returns

Type	Description
double	double value of field, or NAN if field not found

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

GetUserDefinedInt(int)

Return a user defined value of type int

Declaration

public string GetUserDefinedInt(int fieldNo)

Parameters

Type	Name	Description
int	fieldNo	Index of field to retrieve value for

Returns

Type	Description
string	String representation of the value of specified field

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

GetUserDefinedInt(string)

Get the int udef value based on the prog.id name of the udef field.

Declaration

public int GetUserDefinedInt(string progId)

Parameters

Type	Name	Description
string	progId	Program name of udef field

Returns

Type	Description
int	int value of field, or MINVALUE if field not found

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

GetUserDefinedString(int)

Return a user defined value of type string

Declaration

public string GetUserDefinedString(int fieldNo)

Parameters

Type	Name	Description
int	fieldNo	Index of field to retrieve value for

Returns

Type	Description
string	Value of specified field

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

GetUserDefinedString(string)

Get the string udef value based on the prog.id name of the udef field.

Declaration

public string GetUserDefinedString(string progId)

Parameters

Type	Name	Description
string	progId	Program name of udef field

Returns

Type	Description
string	string value of field, or NULL if field not found

Remarks

To create an instance of SaleInfoProvider, use

var info = ClassFactory.Create<ISaleInfo2>(sale);

where sale is a Sale, to use an already-loaded entity object (that may also contain unsaved data); or where sale is an int that is a saleId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleSaleInfo instead, fully populate it, and pass that to the factory.

Implements

ISaleInfo3

ISaleInfo2

ISaleInfo

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)