The CReferenceData type exposes the following members.

Methods

  NameDescription
Public methodCheckLookupCode
Checks to see if the code supplied exists in the lookup table referenced in lookupKey. If so, and a substitute is defined for the code, the substitute is returned in the substitute parameter.
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 methodGetAddressFormula
Given the Address Format "key", returns the associated formula used to build the Full Address
Public methodGetBadAddressReasonDescription
Given the BadAddressReasonCode (key to the reference table of bad address reasons) returns the matching description
Public methodGetCashAccount
Given a Cash Account Code, returns the associated CCashAccount object, or NULL if the cash account name is not found
Public methodGetCountry
Given a country name, returns the associated CCountry object, or NULL if the country name is not found
Public methodGetCustomerType
Given a customer type code (key to the customer/member type), returns the associated CCustomerType object, or NULL if the customer type is not found
Public methodGetExtTableDefinition
Given the name of an EXTTable gets a CExtTable object containing its definition, but no instance data.
Public methodGetExtViewDefinition
Given the name of an EXTView gets a CExtView object containing its definition, but no instance data.
Public methodGetFinancialEntity
Given the organizationCode (key to the financial entity), returns the associated CFinancialEntity object, or NULL if the financial entity is not found
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLookupCodeDescription
Given the tableName (really the general look up table Table Name) returns a KeyValuePair array of all of the Codes and Values in that "table".
Public methodGetLookupDescription
Given the tableName (really the general look up table Table Name) and the Code returns the description.
Public methodGetLookupDescriptionBySubtituteOrCode
Given the tableName (really the general look up table Table Name) and the Substitute or Code returns the description.
Public methodGetLookupSubstituteOrCodeDescription
Given the tableName (really the general look up table Table Name) returns a KeyValuePair array of all of the Substitutes or Codes and Values in that "table".
Public methodGetLookupValues
Given the lookup key (really the general look up table Table Name) returns a string array of all of the Code values in that "table". Also handles other reference "tables" like Countries, Customer/Member Types, Chapters, Actity Types and Cash Accounts.
Public methodGetLookupValuesForDropDown
Given the lookup key (really the general look up table Table Name) returns a string array of the distinct code value in that "table". Distinct means that two code values that substitute to the same substitute value would only return the one substitute. However, code value without a substitute would be returned as is. This is useful for drop down lists. Also handles other reference "tables" like Countries, Customer/Member Types, Chapters, Actity Types and Cash Accounts.
Public methodGetModuleDefaultFinEntity
Returns the default financial entity for the supplied iMIS module. If the module financial entity is not defined, then the System Default Financial Entity is returned.
Public methodGetNameIndex
Given a property name, in the form Table_Name.COLUMN_NAME, returns the number of the custom index which indexes that property (1 thru 4), or 0 if the property is not indexed. For example, if the 2nd custom index is on Name_Demo.CERTIFICATE_NUMBER, and "Name_Demo.CERTIFICATE_NUMBER" is supplied, 2 will be returned.
Public methodGetSecurityGroup
Given a security group code, returns the associated CSecurityGroup object, or NULL if the security group is not found
Public methodGetSenderDescription
Given the sender code, returns the description.
Public methodGetSystemParameterValue(String)
Gets the value associated with the given system parameter
Public methodGetSystemParameterValue(iMISModule, String)
Gets the value associated with the given system parameter
Public methodGetSystemParameterValueBool
Gets the value associated with the given system parameter
Public methodGetTaxAuthority
Given a tax authority code (key to the tax authority), returns the associated CTaxAuthority object, or NULL if the tax authority is not found
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 methodPeriodicRefresh
Refreshes the cached variable values if the supplied interval has passed since the last refresh.
Public methodRefresh
Refreshes the cached variable values.
Public methodRefreshSystemParameters
Refreshes the cached system parameter values.
Public methodSetSystemParameterValue(String, Int32)
Sets the value associated with the given system parameter
Public methodSetSystemParameterValue(String, String)
Sets the value associated with the given system parameter
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodValidateActivityType
Checks to see if the supplied Activity Type is valid
Public methodValidateFinancialTerms
Checks to see if the supplied terms code is valid
Public methodValidateOrderType
Checks to see if the supplied Order Type is valid

Properties

  NameDescription
Public propertyActivityTypes
Gets a list of all of the Activity Types defined in the iMIS instance
Public propertyAppeals
Gets the list of Appeals defined in the iMIS instance. Key is the AppealCode, Value is the Appeal's title
Public propertyBadAddressReasons
Gets the list of possible reasons that an address might be bad
Public propertyCampaigns
Gets the list of Campaigns defined in the iMIS instance. Key is the CampaignCode, Value is the campaing's title
Public propertyCashAccounts
Gets the list of Cash Accounts defined in the iMIS instance, as CCashAccount objects
Public propertyChapters
Gets a list of all of the "chapters" (a.k.a., affiliates, subsidiaries, etc.) defined in the iMIS instance
Public propertyCommitteePositions
Gets the list of Committee Positions defined in the iMIS instance. Key is the position code, Value is the position title
Public propertyContactStatus
Gets ahe list of statuses assignable to a Contact.
Public propertyCountries
Gets the list of Countries defined in the iMIS instance, as CCountry objects
Public propertyCustomerTypes
Gets the list of Customer types defined in the iMIS instance as CCustomerType objects
Public propertyExtTableNames
Gets an array listing the names of all of the ExtTables (User Defined Tables) defined in the system
Public propertyExtViewNames
Gets an array listing the names of all of the ExtViews (User Defined Windows) defined in the system
Public propertyFinancialEntities
Gets the list of Financial Entities defined in the iMIS instance as CFinancialEntity objects
Public propertyFinancialTerms
Gets the list of Terms defined in the iMIS instance. Key is the TermsCode, Value is a human meaningful description
Public propertyFundraisingDistributions
Gets the list of fundraising Distributions defined in the iMIS instance. Key is the ProductCode, Value is the product's title
Public propertyFunds
Gets the list of Financial Entities defined in the iMIS instance that are funds, as CFinancialEntity objects
Public propertyStatic memberLastRefreshDateTime
Gets the date and time that the cached object was lasted refreshed.
Public propertyNavMenuTable
Gets a DataTable that contains all the Nav_Menu rows.
Public propertyOrderTypes
Gets the list of Order Types defined in the iMIS instance
Public propertyPaymentAuthorizationAccounts
Gets the list of Payment Authorization Accounts (CCAuthAccts) defined in the iMIS instance, as CPaymentAuthorizationAccount objects
Public propertyPrefixes
Gets the list of name prefixes defined in the iMIS instance. For example, Mr., Mrs., Dr. etc.
Public propertySecurityGroups
Gets the list of Security groups defined in the iMIS instance as CSecurityGroup objects
Public propertySenders
Gets the list of fundraising Senders defined in the iMIS instance. Key is the SenderCode, Value is the sebder's description
Public propertySolicitors
Gets the list of Solicitors defined in the iMIS instance. Key is the SolicitorID, Value is the Solicitor's name
Public propertyStateProvinceLookup
Gets a list of all of the states/provinces defined in the iMIS instance
Public propertyStatesProvinces
Gets a list of all of the states/provinces defined in the iMIS instance
Public propertySuffixes
Gets the list of name suffixes defined in the iMIS instance. For example, Jr., Sr., III, etc
Public propertySystemDefaultFinancialEntity
Gets the default financial entity defined for the iMIS instance or NULL if no default financial entity is defined
Public propertyTaxAuthorities
Gets the list of Taxing Authorities defined in the iMIS instance, as CTaxAuthority objects
Public propertyWebsiteTable
Gets a DataTable that contains all the Website rows.
Public propertyWorkflowStatus
Gets an array of WorkflowStatus defined in the iMIS instance as CWorkflowStatus objects

See Also