Commodity object

Commodity properties and column mapping

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

c =commodity
Property Database Column

Name

Data Type (in C#)

Name

Data Type

Modifiable

Comments

1

Code

string

c.cmd_code

varchar(8)

Insert/Update

2

CommodityClass

string

c.cmd_class

varchar(8)

Insert/Update

3

CommodityClass2

string

c.cmd_class2

varchar(8), null

Insert/Update

First available in 15.1.0

4

DataSourceID

string

N/A

Not mapped

5

Description

String

c.cmd_name

varchar(60)

Insert/Update

6

Hazardous

Int

c.cmd_hazardous

int

Insert/Update

7

IsDirty

Bool

N/A

Not mapped or used in service

8

IsNew

Bool

N/A

Not mapped, set to false during save to update

9

IsValid

Bool

N/A

Not mapped or used in service

10

Misc1

string

c.cmd_misc1

varchar(254)

Insert/Update

11

Misc2

string

c.cmd_misc2

varchar(254)

Insert/Update

12

Misc3

string

c.cmd_misc3

varchar(254)

Insert/Update

13

Misc4

string

c.cmd_misc4

varchar(254)

Insert/Update

14

Pin

string

c.cmd_pin

varchar(8)

Insert/Update

15

UpdateableProperties

CommodityUpdateInfo

N/A

Not mapped

Commodity methods

The Return Value for all methods is Commodity.ReturnObject.

Internal

Parameters

Method Name

Name

Data type (in C#)

Commodity.ReturnObject.
ReturnCode

Description

GetCommodity

commodityCode

String

0 = successful

100 = no records found

1000 = errors occurred

Gets the Commodity object corresponding to the provided commodity code

RetrieveCommodities

N/A

0 = successful

100 = no records found

1000 = errors occurred

Returns all Commodity objects that meet the provided criteria

External

Parameters

Method Name

Name

Data type (in C#)

Commodity.ReturnObject.
ReturnCode

Description

GetCommodity

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Gets the Commodity object corresponding to the provided commodity code

commodityCode

String

RetrieveCommodities

tokenValue

string

0 = successful

100 = no records found

1000 = errors occurred

Returns all Commodity objects that meet the provided criteria

Commodity.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List<string>

2

ErrorObjectIndexList

List<int>

3

Exceptions

List<Exception>

4

ReferenceObjects

List<Commodity>

5

ReturnCode

int

6

TraceMessages

List<string>

7

WarningMessages

List<string>

CommodityUpdateInfo object

  • Data types (in C#) for all properties are bool.

  • Set the property to true to update the corresponding Commodity property.

Property Name

1

Code

2

CommodityClass

3

Description

4

Hazardous

5

Misc1

6

Misc2

7

Misc3

8

Misc4

9

Pin