The CFunction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CFunction(IiMISUser, CEvent, String) |
This constructor is used to create a new CFunction object.
|
| CFunction(IiMISUser, String, String) |
This constructor is used to instantiate existing CFunction objects from the database.
|
Methods
| Name | Description | |
|---|---|---|
| AddKitItem(CStandardProduct) |
Adds quantity 1 of the provided product to the kit that comprises this CProduct.
(Inherited from CProduct.) |
| AddKitItem(CStandardProduct, Double, String) |
Adds the specified quantity of the provided product to the kit that comprises this CProduct.
(Inherited from CProduct.) |
 | CheckAndModifyEditStatus |
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.) |
| Delete |
Marks this object to be deleted when the save is done
(Inherited from iboBase.) |
| Equals | (Inherited from Object.) |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetFuncFeeByRegClass |
Gets the CFunctionFee object for this CFunction for the specified registrant class.
|
 | GetFunctions | |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetKitItem |
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.
(Inherited from CProduct.) |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| NewFunctionFee |
Creates a new CFunctionFee object for this CFunction.
|
| NumberOfRegistrants |
Returns the number of registrations currently stored for the indicated event and function. Canceled registrations are
not included in the count. |
| RemoveKitItem(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.
(Inherited from CProduct.) |
| RemoveKitItem(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.
(Inherited from CProduct.) |
| Save()()()() |
Saves this CFunction instance to the database using a new DataServer object.
|
| Save(DataServer) |
Saves the Product along with all of its child records to the database.
(Inherited from CProduct.) |
| Save(DataServer, Boolean) |
Saves the Product along with all of its child records to the database.
(Inherited from CProduct.) |
| ToString | (Inherited from Object.) |
| Validate |
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.
(Inherited from CProduct.) |
Fields
| Name | Description | |
|---|---|---|
 | mAdjustmentAccount |
The general ledger account to be used for adjustments.
(Inherited from CProduct.) |
| mAppealCode | The default AppealCode associated with this product. (Inherited from CProduct.) |
| mApplyImageFlag |
Contains the value of the APPLY_IMAGE field of the Product table.
(Inherited from CProduct.) |
| mApplyInfoFlag |
Contains the value of the APPLY_INFO field of the Product table.
(Inherited from CProduct.) |
| mApplyThumbnailFlag |
Contains the value of the APPLY_THUMBNAIL field of the Product table.
(Inherited from CProduct.) |
| mAttributes |
Contains the value of the ATTRIBUTES field of the Product table.
(Inherited from CProduct.) |
| mCampaignCode | The default CampaignCode associated with this product. (Inherited from CProduct.) |
| mCOGAccount |
The general ledger account for cost-of-goods sold.
(Inherited from CProduct.) |
| mCommissionRate | The commission rate on this product. (Inherited from CProduct.) |
| mDecimalPoints |
Contains the value of the DECIMAL_POINTS field of the Product table.
(Inherited from CProduct.) |
| mEditStatus | The edit status (unchanged, modified, etc) of this record. (Inherited from iboBase.) |
| mErrors | The current list of errors encountered by this class instance during processing. (Inherited from iboBase.) |
| mFairMarketValue | The fair market value for this product. (Inherited from CProduct.) |
| mGroup1 |
Contains the value of the GROUP_1 field of the Product table.
(Inherited from CProduct.) |
| mGroup2 |
Contains the value of the GROUP_2 field of the Product table.
(Inherited from CProduct.) |
| mGroup3 |
Contains the value of the GROUP_3 field of the Product table.
(Inherited from CProduct.) |
| mInventoryAccount |
The general ledger account to be used for inventory.
(Inherited from CProduct.) |
| mIsCommissionable | Whether commission can be paid on this product. (Inherited from CProduct.) |
| mIsComplimentary | Whether this product is complimentary. (Inherited from CProduct.) |
| mIsFRItem | Whether this product is a fundraising item. (Inherited from CProduct.) |
| mIsKit |
Indicates whether the product is a kit.
(Inherited from CProduct.) |
| mIsPremium |
Indicates whether this product is a premium for a fundraising effort.
(Inherited from CProduct.) |
| mKitItems |
A collection of CKitItem objects representing the constituent products
that are part of this kit product.
(Inherited from CProduct.) |
| mLocation |
Contains the value of the LOCATION field of the Product table.
(Inherited from CProduct.) |
| mLotSerialExist |
Contains the value of the LOT_SERIAL_EXIST field of the Product table.
(Inherited from CProduct.) |
| mNote | The note for this product. (Inherited from CProduct.) |
| mOtherDescription |
Contains the value of the OTHER_DESC field of the Product table.
(Inherited from CProduct.) |
| mPLPCode |
Contains the value of the PLP_CODE field of the Product table.
(Inherited from CProduct.) |
| mPrice1 |
Contains the value of the PRICE_1 field of the Product table.
(Inherited from CProduct.) |
| mPrice2 |
Contains the value of the PRICE_2 field of the Product table.
(Inherited from CProduct.) |
| mPrice3 |
Contains the value of the PRICE_3 field of the Product table.
(Inherited from CProduct.) |
| mProductCategoryCode | The product category code for this product. (Inherited from CProduct.) |
| mProrate |
Contains the value of the PRORATE field of the Product table.
(Inherited from CProduct.) |
| mRenewMonths |
Contains the value of the RENEW_MONTHS field of the Product table.
(Inherited from CProduct.) |
| mTaxableValue | The taxable value of this product. (Inherited from CProduct.) |
| mUnitOfMeasure | The unit of measurement for this product. (Inherited from CProduct.) |
| mWeight | The unit weight for this product. (Inherited from CProduct.) |
Properties
| Name | Description | |
|---|---|---|
 | ActualAttendance |
Gets or sets the actual attendance for this CFunction object.
This is ACTUAL_ATTENDANCE in the Product_Function table.
|
 | AdjustmentAccount |
Gets or sets the General Ledger account used to track adjustments to sales of this product.
(Inherited from CProduct.) |
| AppealCode |
Gets or sets the APPEAL_CODE field of the CProduct.
(Inherited from CProduct.) |
| ApplyImageFlag |
Gets or sets the APPLY_IMAGE field of the CProduct.
(Inherited from CProduct.) |
| ApplyInfoFlag |
Gets or sets the APPLY_INFO field of the CProduct.
(Inherited from CProduct.) |
| ApplyThumbnailFlag |
Gets or sets the APPLY_THUMBNAIL field of the CProduct.
(Inherited from CProduct.) |
| Attributes |
Gets or sets the ATTRIBUTES field of the CProduct.
(Inherited from CProduct.) |
| BeginDateTime |
Gets or sets the begin date and time for this CFunction object.
This is BEGIN_DATE_TIME in the Product_Function table.
|
| CampaignCode |
Gets or sets the CAMPAIGN_CODE field of the CProduct.
(Inherited from CProduct.) |
| CatalogDescription |
Gets or sets the CATALOG_DESC field of the CProduct.
(Inherited from CProduct.) |
| CeuAmount |
Gets or sets the CEU amount for this CFunction object.
This is CEU_AMOUNT in the Product_Function table.
|
| CeuType |
Gets or sets the CEU type for this CFunction object.
This is CEU_TYPE in the Product_Function table.
|
| CommissionRate |
Gets or sets the salesperson's commission rate for this product.
(Inherited from CProduct.) |
| ConflictCode |
Gets or sets the conflict code for this CFunction object.
This is CONFLICT_CODE in the Product_Function table.
|
| CostOfGoodsAccount |
Gets or sets the General Ledger account used to track the Cost of Goods for this product.
(Inherited from CProduct.) |
| CourseCode |
Gets or sets the course code for this CFunction object.
This is COURSE_CODE in the Product_Function table.
|
| DecimalPoints |
Gets or sets the DECIMAL_POINTS field of the CProduct.
(Inherited from CProduct.) |
| DefaultEarlyFee |
Gets or sets the default early registration fee for this CFunction object. This is PRICE_1 in the Product table.
|
| DefaultLateFee |
Gets or sets the default late registration fee for this CFunction object. This is PRICE_3 in the Product table.
|
| DefaultRegularFee |
Gets or sets the default regular registration fee for this CFunction object. This is PRICE_2 in the Product table.
|
| DeferredIncomeAccount |
Gets or sets the General Ledger account into which deferred income from the sales of this product should be credited.
(Inherited from CProduct.) |
| Description |
Gets or sets the product's description.
(Inherited from CProduct.) |
| EditStatus |
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus (Inherited from iboBase.) |
| EndDateTime |
Gets or sets the end date and time for this CFunction object.
This is END_DATE_TIME in the Product_Function table.
|
| Errors |
The collection of CError objects (error and warning messages) associated with this object instance
(Inherited from iboBase.) |
| ErrorsCount |
Gets the number of error and warning messages that have been set on this object.
(Inherited from iboBase.) |
| EventCode |
Gets the event code for this CFunction object. This is PRODUCT_MAJOR in the Product table.
|
| ExpectedAttendance |
Gets or sets the expected attendance for this CFunction object.
This is EXPECTED_ATTENDANCE in the Product_Function table.
|
| FairMarketValue |
Gets or sets the FAIR_MARKET_VALUE field of the CProduct.
(Inherited from CProduct.) |
| Fees |
Gets an array of CFunctionFee objects associated with this CFunction object.
|
| FinancialEntityCode |
Gets or sets a reference to the Financial Entity (Organization) to which this product belongs.
(Inherited from CProduct.) |
| FunctionCode |
Gets the function code for this CFunction object. This is PRODUCT_MINOR in the Product table.
|
| FunctionTypeCode |
Gets or sets the function type code for this CFunction object.
This is FUNCTION_TYPE in the Product_Function table.
|
| GaraunteedAttendance |
Gets or sets the guaranteed attendance for this CFunction object.
This is GUARANTEED_ATTENDANCE in the Product_Function table.
|
| Group1 |
Gets or sets Group1 for this CFunction object. This is GROUP_1 in the Product table.
|
| Group2 |
Gets or sets Group2 for this CFunction object. This is GROUP_2 in the Product table.
|
| Group3 |
Gets or sets Group3 for this CFunction object. This is GROUP_3 in the Product table.
|
| ImageUrl |
Gets or sets an internet URL that points to an image of this product
(Inherited from CProduct.) |
| IncomeAccount |
Gets or sets the General Ledger account into which income from the sales of this product should be credited.
(Inherited from CProduct.) |
| InfoUrl |
Gets or sets an internet URL that points to a page containing information about this product
(Inherited from CProduct.) |
| InventoryAccount |
Gets or sets the General Ledger account used to track inventory of this product.
(Inherited from CProduct.) |
| IsAcceptingWebRegistration |
Gets or sets an indication of whether registrations are accepted from the web for this CFunction object.
This is WEB_ENABLED in the Product_Function table.
|
| IsAutoEnroll | |
| IsCommissionable |
Gets or sets the COMMISIONABLE field of the CProduct.
(Inherited from CProduct.) |
| IsComplimentary |
Gets or sets an indication of whether this this CFunction object is complimentary.
This is COMPLIMENTARY in the Product table.
|
| IsCueEntered |
Gets or sets an indication of whether CEU is entered for this CFunction object.
This is CEU_ENTERED in the Product_Function table.
|
| IsFundRaisingFunction |
Gets or sets an indication of whether this CFunction is a fundraising function.
This is IS_FR_ITEM in the Product_Function table for iMIS 10.6 and later.
|
| IsFundRaisingItem |
Gets or sets the IS_FR_ITEM field of the CProduct.
(Inherited from CProduct.) |
| IsKit |
Gets or sets the IS_KIT field of the CProduct.
(Inherited from CProduct.) |
| IsParent |
Gets or sets an indication of whether this CFunction object is a parent.
This is PARENT in the Product_Function table.
|
| IsPremium |
Gets or sets the PREMIUM field of the CProduct.
(Inherited from CProduct.) |
| IsPSTTaxable |
Gets or sets the PST_TAXABLE field of the CProduct.
(Inherited from CProduct.) |
| IsStockItem |
Gets or sets the STOCK_ITEM field of the CProduct.
(Inherited from CProduct.) |
| IsTaxable |
Gets or sets the TAXABLE field of the CProduct.
(Inherited from CProduct.) |
| KitItems | (Inherited from CProduct.) |
| LastTicket |
Gets or sets the last ticket number for this CFunction object.
This is LAST_TICKET in the Product_Function table.
|
| Location |
Gets or sets the LOCATION field of the CProduct.
(Inherited from CProduct.) |
| LotSerialExistsFlag |
Gets or sets LOT_SERIAL_EXIST in the Product table.
|
| MaximumAttendees |
Gets or sets the maximum attendance for this CFunction object.
This is MAXIMUM_ATTENDANCE in the Product_Function table.
|
| MaxRegistrationsPerRegistrant |
Gets or sets the maximum number of registrations per registrant for this CFunction object.
This is WEB_MULTI_REG in the Product_Function table for iMIS 10.2 and later.
|
| MinimumAttendance |
Gets or sets the minimum attendance for this CFunction object.
This is MINIMUM_ATTENDANCE in the Product_Function table.
|
| Note |
Gets or sets the NOTE field of the CProduct.
(Inherited from CProduct.) |
| OtherDescription |
Gets or sets the OTHER_DESC field of the CProduct.
(Inherited from CProduct.) |
| OtherTickets |
Gets or sets the other tickets for this CFunction object.
This is OTHER_TICKETS in the Product_Function table.
|
| PaymentPriority |
Gets or sets the PAYMENT_PRIORITY field of the CProduct.
(Inherited from CProduct.) |
| PostDateTime |
Gets or sets the post date and time for this CFunction object.
This is POST_DATE_TIME in the Product_Function table.
|
| Price1 |
Gets or sets the PRICE_1 field of the CProduct.
(Inherited from CProduct.) |
| Price2 |
Gets or sets the PRICE_2 field of the CProduct.
(Inherited from CProduct.) |
| Price3 |
Gets or sets the PRICE_3 field of the CProduct.
(Inherited from CProduct.) |
| PriceRulesExist |
Gets or sets the an indication of whether special pricing rules exist for this product.
(Inherited from CProduct.) |
| PrintTicket |
Gets or sets an indication of whether to print the ticket for this CFunction object.
This is PRINT_TICKET in the Product_Function table.
|
| ProductCategoryCode |
Gets or sets the CATEGORY field of the CProduct.
(Inherited from CProduct.) |
| ProductCode |
Gets the code identifying this product.
(Inherited from CProduct.) |
| ProductMajor |
Gets the major portion of the product code.
(Inherited from CProduct.) |
| ProductMinor |
Gets the minor portion of the product code.
(Inherited from CProduct.) |
| ProductTypeCode |
Gets or sets the code identifying the product type.
(Inherited from CProduct.) |
| PromoteProductFlag |
Gets or sets the PROMOTE field of the CProduct.
(Inherited from CProduct.) |
| ProrateRule |
Gets or sets the PRORATE field of the CProduct.
(Inherited from CProduct.) |
| QuantityAvailable |
Gets the quantity of registrations available for this CFunction. Calculated as MaximumAttendees
minus the current number of registrants as calculated by NumberOfRegistrants(IiMISUser, String, String).
|
| RenewalMonths |
Gets or sets the RENEW_MONTHS field of the CProduct.
(Inherited from CProduct.) |
| SellOnWeb |
Gets or sets an indication of whether this product may be offered for sale on the website.
(Inherited from CProduct.) |
| Sequence |
Gets or sets the sequence number for this CFunction object.
This is SEQ in the Product_Function table.
|
| Settings |
Gets or sets the number of settings for this CFunction object.
This is SETTINGS in the Product_Function table.
|
| SetupDateTime |
Gets or sets the setup date and time for this CFunction object.
This is SETUP_DATE_TIME in the Product_Function table.
|
| SquareFeet |
Gets or sets the square feet for this CFunction object.
This is SQUARE_FEET in the Product_Function table for iMIS 10.5 and later.
|
| StatusCode |
Gets or sets the STATUS field of the CProduct.
(Inherited from CProduct.) |
| TaxableValue |
Gets or sets the TAXABLE_VALUE field of the CProduct.
(Inherited from CProduct.) |
| TaxAuthorityCode |
Gets or sets the TAX_AUTHORITY field of the CProduct.
(Inherited from CProduct.) |
| ThumbnailUrl |
Gets or sets an internet URL that points to a thumbnail (small) image of this product
(Inherited from CProduct.) |
| Title |
Gets or sets the name of the product.
(Inherited from CProduct.) |
| TotalRevenue |
Gets the total revenue for this CFunction object.
This is LTD_INCOME in the Product_Inventory table.
|
| UnitOfMeasure |
Gets or sets the UNIT_OF_MEASURE field of the CProduct.
(Inherited from CProduct.) |
| VATCode |
Gets or sets VAT tax authority code for this CFunction object.
This is TAX_AUTHORITY in the Product table.
|
| ViewOnWeb |
Gets or sets an indication of whether this product may be displayed on the website.
(Inherited from CProduct.) |
| WebDescription |
Gets or sets the WEB_DESC field of the CProduct.
(Inherited from CProduct.) |
| WebOption |
Gets or sets the WEB_OPTION field of the CProduct.
(Inherited from CProduct.) |
| Weight |
Gets or sets the WEIGHT field of the CProduct.
(Inherited from CProduct.) |
See Also
