The CProduct type exposes the following members.

Constructors

  NameDescription
Public methodCProduct(IiMISUser, String)
This constructor instantiates an existing product from the database.
Public methodCProduct(IiMISUser, String, String)
This constructor creates a new CProduct object.

Methods

  NameDescription
Public methodAddKitItem(CStandardProduct)
Adds quantity 1 of the provided product to the kit that comprises this CProduct.
Public methodAddKitItem(CStandardProduct, Double, String)
Adds the specified quantity of the provided product to the kit that comprises this CProduct.
Protected methodCheckAndModifyEditStatus
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.)
Public methodDelete
Marks this object to be deleted when the save is done
(Inherited from iboBase.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetKitItem
Gets the CKitItem object corresponding to the given ProductCode in the kit. If this CProduct is not a kit, or if the given ProductCode is not present in the kit, returns null.
Public methodStatic memberGetProducts(IiMISUser, String, String, array<SqlParameter>[]()[][])
Retrieves a collection of Products from the database using the supplied SQL FROM and WHERE criteria and parameters. The starting SQL is: SELECT Product.* FROM Product {0} WHERE 1 = 1 {1}. So any additional FROM criteria should look something like: ", Product_Function" or "INNER JOIN Product_Function ON Product.Product_Code = Product_Function.Product_Code" etc. Any additional WHERE criteria should start with AND, like: "AND Product.Product_Code = Product_Function.Product_Code" etc.
Public methodStatic memberGetProducts(DataServer, IiMISUser, String, String, array<SqlParameter>[]()[][])
Retrieves a collection of Products from the database using the supplied SQL FROM and WHERE criteria and parameters. The starting SQL is: SELECT Product.* FROM Product {0} WHERE 1 = 1 {1}. So any additional FROM criteria should look something like: ", Product_Function" or "INNER JOIN Product_Function ON Product.Product_Code = Product_Function.Product_Code" etc. Any additional WHERE criteria should start with AND, like: "AND Product.Product_Code = Product_Function.Product_Code" etc.
Public methodStatic memberGetProductsByType
Retrieves all of the Products from the database that have the given product type
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemoveKitItem(String)
Remove the CProduct specified by the supplied product code from this kit. If this product is not a kit or the specified product is not part of the kit, this method does nothing.
Public methodRemoveKitItem(CProduct)
Remove the specified CProduct from this kit. If this product is not a kit or the CProduct is not part of the kit, this method does nothing.
Public methodSave()()()()
Saves the Product along with all of its child records to the database using a new DataServer object.
Public methodSave(DataServer)
Saves the Product along with all of its child records to the database.
Public methodSave(DataServer, Boolean)
Saves the Product along with all of its child records to the database.
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidate
Validates the data set in the product's properties against cross-property business rules. If any errors are found Validate will return false and the Asi.iBO.Errors property should be checked for details. Validate can be called at any time to check for errors but it will automatically be called at save time.
(Overrides iboBase..::..Validate()()()().)

Fields

  NameDescription
Protected fieldmAdjustmentAccount
The general ledger account to be used for adjustments.
Protected fieldmAppealCode
The default AppealCode associated with this product.
Protected fieldmApplyImageFlag
Contains the value of the APPLY_IMAGE field of the Product table.
Protected fieldmApplyInfoFlag
Contains the value of the APPLY_INFO field of the Product table.
Protected fieldmApplyThumbnailFlag
Contains the value of the APPLY_THUMBNAIL field of the Product table.
Protected fieldmAttributes
Contains the value of the ATTRIBUTES field of the Product table.
Protected fieldmCampaignCode
The default CampaignCode associated with this product.
Protected fieldmCOGAccount
The general ledger account for cost-of-goods sold.
Protected fieldmCommissionRate
The commission rate on this product.
Protected fieldmDecimalPoints
Contains the value of the DECIMAL_POINTS field of the Product table.
Protected fieldmEditStatus
The edit status (unchanged, modified, etc) of this record.
(Inherited from iboBase.)
Protected fieldmErrors
The current list of errors encountered by this class instance during processing.
(Inherited from iboBase.)
Protected fieldmFairMarketValue
The fair market value for this product.
Protected fieldmGroup1
Contains the value of the GROUP_1 field of the Product table.
Protected fieldmGroup2
Contains the value of the GROUP_2 field of the Product table.
Protected fieldmGroup3
Contains the value of the GROUP_3 field of the Product table.
Protected fieldmInventoryAccount
The general ledger account to be used for inventory.
Protected fieldmIsCommissionable
Whether commission can be paid on this product.
Protected fieldmIsComplimentary
Whether this product is complimentary.
Protected fieldmIsFRItem
Whether this product is a fundraising item.
Protected fieldmIsKit
Indicates whether the product is a kit.
Protected fieldmIsPremium
Indicates whether this product is a premium for a fundraising effort.
Protected fieldmKitItems
A collection of CKitItem objects representing the constituent products that are part of this kit product.
Protected fieldmLocation
Contains the value of the LOCATION field of the Product table.
Protected fieldmLotSerialExist
Contains the value of the LOT_SERIAL_EXIST field of the Product table.
Protected fieldmNote
The note for this product.
Protected fieldmOtherDescription
Contains the value of the OTHER_DESC field of the Product table.
Protected fieldmPLPCode
Contains the value of the PLP_CODE field of the Product table.
Protected fieldmPrice1
Contains the value of the PRICE_1 field of the Product table.
Protected fieldmPrice2
Contains the value of the PRICE_2 field of the Product table.
Protected fieldmPrice3
Contains the value of the PRICE_3 field of the Product table.
Protected fieldmProductCategoryCode
The product category code for this product.
Protected fieldmProrate
Contains the value of the PRORATE field of the Product table.
Protected fieldmRenewMonths
Contains the value of the RENEW_MONTHS field of the Product table.
Protected fieldmTaxableValue
The taxable value of this product.
Protected fieldmUnitOfMeasure
The unit of measurement for this product.
Protected fieldmWeight
The unit weight for this product.

Properties

  NameDescription
Protected propertyAdjustmentAccount
Gets or sets the General Ledger account used to track adjustments to sales of this product.
Public propertyAppealCode
Gets or sets the APPEAL_CODE field of the CProduct.
Public propertyApplyImageFlag
Gets or sets the APPLY_IMAGE field of the CProduct.
Public propertyApplyInfoFlag
Gets or sets the APPLY_INFO field of the CProduct.
Public propertyApplyThumbnailFlag
Gets or sets the APPLY_THUMBNAIL field of the CProduct.
Protected propertyAttributes
Gets or sets the ATTRIBUTES field of the CProduct.
Public propertyCampaignCode
Gets or sets the CAMPAIGN_CODE field of the CProduct.
Public propertyCatalogDescription
Gets or sets the CATALOG_DESC field of the CProduct.
Protected propertyCommissionRate
Gets or sets the salesperson's commission rate for this product.
Protected propertyCostOfGoodsAccount
Gets or sets the General Ledger account used to track the Cost of Goods for this product.
Protected propertyDecimalPoints
Gets or sets the DECIMAL_POINTS field of the CProduct.
Public propertyDeferredIncomeAccount
Gets or sets the General Ledger account into which deferred income from the sales of this product should be credited.
Public propertyDescription
Gets or sets the product's description.
Public propertyEditStatus
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus
(Inherited from iboBase.)
Public propertyErrors
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.)
Public propertyErrorsCount
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.)
Protected propertyFairMarketValue
Gets or sets the FAIR_MARKET_VALUE field of the CProduct.
Public propertyFinancialEntityCode
Gets or sets a reference to the Financial Entity (Organization) to which this product belongs.
Protected propertyGroup1
Gets or sets the GROUP_1 field of the CProduct.
Protected propertyGroup2
Gets or sets the GROUP_2 field of the CProduct.
Protected propertyGroup3
Gets or sets the GROUP_3 field of the CProduct.
Public propertyImageUrl
Gets or sets an internet URL that points to an image of this product
Public propertyIncomeAccount
Gets or sets the General Ledger account into which income from the sales of this product should be credited.
Public propertyInfoUrl
Gets or sets an internet URL that points to a page containing information about this product
Protected propertyInventoryAccount
Gets or sets the General Ledger account used to track inventory of this product.
Protected propertyIsCommissionable
Gets or sets the COMMISIONABLE field of the CProduct.
Protected propertyIsComplimentary
Gets or sets the COMPLIMENTARY field of the CProduct.
Protected propertyIsFundRaisingItem
Gets or sets the IS_FR_ITEM field of the CProduct.
Public propertyIsKit
Gets or sets the IS_KIT field of the CProduct.
Protected propertyIsPremium
Gets or sets the PREMIUM field of the CProduct.
Public propertyIsPSTTaxable
Gets or sets the PST_TAXABLE field of the CProduct.
Public propertyIsStockItem
Gets or sets the STOCK_ITEM field of the CProduct.
Public propertyIsTaxable
Gets or sets the TAXABLE field of the CProduct.
Public propertyKitItems
Gets an array of CKitItem objects for this CProduct. If the CProduct is not a kit, returns null.
Protected propertyLocation
Gets or sets the LOCATION field of the CProduct.
Protected propertyLotSerialExistsFlag
Gets or sets the LOT_SERIAL_EXIST field of the CProduct.
Public propertyNote
Gets or sets the NOTE field of the CProduct.
Public propertyOtherDescription
Gets or sets the OTHER_DESC field of the CProduct.
Protected propertyPaymentPriority
Gets or sets the PAYMENT_PRIORITY field of the CProduct.
Protected propertyPrice1
Gets or sets the PRICE_1 field of the CProduct.
Protected propertyPrice2
Gets or sets the PRICE_2 field of the CProduct.
Protected propertyPrice3
Gets or sets the PRICE_3 field of the CProduct.
Public propertyPriceRulesExist
Gets or sets the an indication of whether special pricing rules exist for this product.
Protected propertyProductCategoryCode
Gets or sets the CATEGORY field of the CProduct.
Public propertyProductCode
Gets the code identifying this product.
Public propertyProductMajor
Gets the major portion of the product code.
Public propertyProductMinor
Gets the minor portion of the product code.
Public propertyProductTypeCode
Gets or sets the code identifying the product type.
Public propertyPromoteProductFlag
Gets or sets the PROMOTE field of the CProduct.
Protected propertyProrateRule
Gets or sets the PRORATE field of the CProduct.
Protected propertyRenewalMonths
Gets or sets the RENEW_MONTHS field of the CProduct.
Public propertySellOnWeb
Gets or sets an indication of whether this product may be offered for sale on the website.
Public propertyStatusCode
Gets or sets the STATUS field of the CProduct.
Public propertyTaxableValue
Gets or sets the TAXABLE_VALUE field of the CProduct.
Public propertyTaxAuthorityCode
Gets or sets the TAX_AUTHORITY field of the CProduct.
Public propertyThumbnailUrl
Gets or sets an internet URL that points to a thumbnail (small) image of this product
Public propertyTitle
Gets or sets the name of the product.
Protected propertyUnitOfMeasure
Gets or sets the UNIT_OF_MEASURE field of the CProduct.
Public propertyViewOnWeb
Gets or sets an indication of whether this product may be displayed on the website.
Public propertyWebDescription
Gets or sets the WEB_DESC field of the CProduct.
Public propertyWebOption
Gets or sets the WEB_OPTION field of the CProduct.
Protected propertyWeight
Gets or sets the WEIGHT field of the CProduct.

See Also