The CContact type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| CContact(IiMISUser) |
Creates a brand new contact with properties initialized to their defaults
| |
| CContact(IiMISUser, String) |
Creates a CContact object for an exising contact by reading the existing data from the database
|
Methods
| Name | Description | |
|---|---|---|
| BillDuesSubscriptions |
Bill dues subscriptions for the given effective date.
| |
| BillNonDuesSubscriptions |
Bill non-dues subscriptions for the given effective date.
| |
| BillSingleNonDuesSubscription |
Bill non-dues subscriptions for the given product for the given effective date.
| |
| CheckAndModifyEditStatus |
Sets the EditStatus to Modified if it is Unchanged
(Inherited from iboBase.) | |
| ConvertGuest |
Converts an "IBOGuest" anonymous contact into a real CContact
| |
| CreateUserSecurity |
Adds security information.
| |
| Delete |
iBoBase override to ensure that we get rid of CContactUser when we delete CContact
(Overrides iboBase..::..Delete()()()().) | |
| 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.) | |
| GetAddressByNum |
Gets the address object with the given address num (key to the address) from this contact
| |
| GetAddressByPurpose |
Given the address purpose (AddressPurpose) returns the address with that purpose, if any.
| |
| GetContacts(IiMISUser, String, String, array<SqlParameter>[]()[][]) |
Retrieves a collection of Contacts from the database using the supplied SQL FROM and WHERE criteria and parameters.
The starting SQL is: SELECT Name.* FROM Name {0} WHERE 1 = 1 {1}. So any additional FROM criteria should look something like:
", Name_Note" or "INNER JOIN Name_Note ON Name.ID = Name_Note.ID" etc. Any additional WHERE criteria should start with AND, like:
"AND Name.ID = Name_Note.ID" etc.
| |
| GetContacts(DataServer, IiMISUser, String, String, array<SqlParameter>[]()[][]) |
Retrieves a collection of Contacts from the database using the supplied SQL FROM and WHERE criteria and parameters.
The starting SQL is: SELECT Name.* FROM Name {0} WHERE 1 = 1 {1}. So any additional FROM criteria should look something like:
", Name_Note" or "INNER JOIN Name_Note ON Name.ID = Name_Note.ID" etc. Any additional WHERE criteria should start with AND, like:
"AND Name.ID = Name_Note.ID" etc.
| |
| GetContacts(IiMISUser, String, String, String, array<SqlParameter>[]()[][]) |
Retrieves a collection of Contacts from the database using the supplied SQL FROM and WHERE criteria, ORDER BY clause and parameters.
The starting SQL is: SELECT Name.* FROM Name {0} WHERE 1 = 1 {1} ORDER BY {2}. So any additional FROM criteria should look something like:
", Name_Note" or "INNER JOIN Name_Note ON Name.ID = Name_Note.ID" etc. Any additional WHERE criteria should start with AND, like:
"AND Name.ID = Name_Note.ID" etc. The ORDER BY should look like: "Name.LAST_NAME" or "Name.LAST_NAME DESC" etc.
| |
| GetContacts(DataServer, IiMISUser, String, String, String, array<SqlParameter>[]()[][]) |
Retrieves a collection of Contacts from the database using the supplied SQL FROM and WHERE criteria, ORDER BY clause and parameters.
The starting SQL is: SELECT Name.* FROM Name {0} WHERE 1 = 1 {1} ORDER BY {2}. So any additional FROM criteria should look something like:
", Name_Note" or "INNER JOIN Name_Note ON Name.ID = Name_Note.ID" etc. Any additional WHERE criteria should start with AND, like:
"AND Name.ID = Name_Note.ID" etc. The ORDER BY clause should look like: "Name.LAST_NAME" or "Name.LAST_NAME DESC" etc.
| |
| GetExtTableByName |
Finds the ExtTable instance with the given name for the Contact and returns a reference to it.
| |
| GetExtViewByName |
Finds the ExtView instance with the given name for the Contact and returns a reference to it.
| |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| NewActivity |
Adds a new CActivity object to the Contact and returns a reference to it.
| |
| NewAddress()()()() |
Adds a new Address object to the Contact and returns a reference to it.
| |
| NewAddress(String) |
Adds a new Address object to the Contact and returns a reference to it.
| |
| NewExtTableRow |
Adds a new instance of a CExtTable with the given name and returns a reference to it.
| |
| NewExtView |
Adds a new instance of the ExtView with the given name and returns a reference to it.
| |
| NewNote |
Adds a new note object to the Contact and returns a reference to it.
| |
| NewSubscription |
Used to create a new CSubscription | |
| Save()()()() |
Saves the Contact record, along with all of its child records, to the database
| |
| Save(DataServer) |
Saves the Contact record, along with all of its child records, to the database
| |
| Save(DataServer, Boolean) |
Saves the Contact record, along with all of its child records, to the database
| |
| SetContactId |
Sets the ContactId to the value sent in. This method overrides any Automatic ID generation and should
be use carefully.
| |
| SetInstituteContactId |
Sets the InstituteContactId for the contact with the option to flowdown the name and address. The InstituteContactId property
should normally be used, which is the same as calling this function but with true sent for both flowdown options.
Use this method to override one or both of the flowdown options.
| |
| SetInstituteReference |
Sets the CompanyID and CompanyMemberType for a contact. This should only be used for bulk load operations where
the company may not yet exist when its employees or subsidiaries are loaded. Normally, the CompanyID property
should be set instead.
| |
| SetNames |
Calls internal methods to calculcate FullName and LastFirst
(Inherited from CContactBasic.) | |
| ToString | (Inherited from Object.) | |
| UpgradeBasic |
Upgrades a CContactBasic object to a CContact object. Used to take the basic contact
and address information created for orders and the like and turn them into ream Contacts in the
Contact Management system.
| |
| Validate()()()() |
Validates the data set in the contact'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 CContactBasic..::..Validate()()()().) | |
| Validate(DataServer) |
Validates the data set in the contact's properties against cross-property business rules. I 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.
|
Fields
| Name | Description | |
|---|---|---|
| m_blnCompanyRecord |
Whether or not this contact is an Institute.
(Inherited from CContactBasic.) | |
| m_blnDupMatchInfoDirty |
Whether or not duplicate match key is out of date.
(Inherited from CContactBasic.) | |
| m_DisableNameUpdates |
Whether or not to automatically update FullName and LastFirst
(Inherited from CContactBasic.) | |
| m_strCompany |
Company name
(Inherited from CContactBasic.) | |
| m_strCompanySort |
Company sort
(Inherited from CContactBasic.) | |
| m_strContactId |
Contact ID
(Inherited from CContactBasic.) | |
| m_strDesignation |
Designation
(Inherited from CContactBasic.) | |
| m_strEmail |
Email
(Inherited from CContactBasic.) | |
| m_strFax |
Fax
(Inherited from CContactBasic.) | |
| m_strFirstName |
First name
(Inherited from CContactBasic.) | |
| m_strFullName |
Calculate FullName string
(Inherited from CContactBasic.) | |
| m_strInformal |
Informal name
(Inherited from CContactBasic.) | |
| m_strLastFirst |
Calculated LastFirst string
(Inherited from CContactBasic.) | |
| m_strLastName |
Last name
(Inherited from CContactBasic.) | |
| m_strMiddleName |
Middle name
(Inherited from CContactBasic.) | |
| m_strPrefix |
Prefix
(Inherited from CContactBasic.) | |
| m_strSuffix |
Suffix
(Inherited from CContactBasic.) | |
| m_strTitle |
Title
(Inherited from CContactBasic.) | |
| m_strTollFreePhone |
Toll free phone
(Inherited from CContactBasic.) | |
| m_strWorkPhone |
Work phone
(Inherited from CContactBasic.) | |
| mChangeLogEntries |
Stores change log entries. Indexed by PropertyName.
(Inherited from CContactBasic.) | |
| 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.) |
Properties
| Name | Description | |
|---|---|---|
| Activities |
Array of activities associated with this contact. Will be null if the contact has no activities.
| |
| ActivityCount |
The number of activities associated with this contact
| |
| AddressCount |
The number of addresses that the contact has.
| |
| Addresses |
Array of addresses associated with this contact. Will be null if the contact has no addresses
| |
| BillingCategory |
The billing category for this contact, used to categorize contacts for billing purposes
| |
| BirthDate |
The birth date of the contact
| |
| Chapter |
The chapter to which the contact belongs (if any)
| |
| ContactId |
The Key to the Contact. Often the member ID for members.
| |
| ContactRank |
The rank of this contact within the organization. Used to sort contacts on a roster. Lower numbers sort to the top.
| |
| ContactStatusCode |
The status of the contact's record. Must be one of the values configured in iMIS.
| |
| CreatedOn |
The date and time that this record was added to iMIS
| |
| CustomerType |
The customer type object representing this contact's customer type
| |
| CustomerTypeChangedOn |
The date and time that the customer type (member type) of this contact was last changed
| |
| CustomerTypeCode |
Gets or sets a reference to the CCustomerType of this customer/contact.
| |
| DefaultAddress |
The main/default address for this contact.
| |
| DefaultSolicitorId |
The ContactId for the default solicitor associated with this Contact.
| |
| Designation |
Gets or sets the designation that follows the customer's/contact's name.
(Inherited from CContactBasic.) | |
| DisableNameUpdates |
Whether or not to automatically update FullName and LastFirst
(Inherited from CContactBasic.) | |
| DisplayCurrency |
Gets or sets the currency code of the currency in which this contact would like monetary amounts displayed.
| |
| DuplicateMatchingFactor |
Gets the result of the duplicate matching formula used to help to prevent duplicate contacts from being input.
| |
| EditStatus |
Indicates the current edit status of this object, i.e., New, Modified, Deleted, or Unchanged. See EEditStatus (Inherited from iboBase.) | |
| EmailAddress |
The primary email address of the contact. Alternative email addresses can be entered in the
Address records
(Overrides CContactBasic..::..EmailAddress.) | |
| 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.) | |
| ExcludeFromDirectory |
Indicates whether or not this contact should be excluded from any print or online directory lists
| |
| ExcludeFromMailings |
Indicates whether or not this contact should be excluded from any mailings
| |
| ExtTableCount |
The number of ExtTables associated with this contact
| |
| ExtTables |
Array of CExtTables associated with this contact. Will be null if the contact has no data in
any ExtTable.
| |
| ExtViewCount |
The number of ExtViews associated with this contact
| |
| ExtViews |
Array of CExtViews associated with this contact. Will be null if the contact has no data in
any ExtView.
| |
| Fax |
The FAX number (facsimile telephone number) of this contact
(Overrides CContactBasic..::..Fax.) | |
| FinancialEntityCode |
The Organization (Financial Entity) to which this contact record belongs. This is used to
distinguish different financial entities within iMIS and is validated against the list setup
in iMIS Organization Names. | |
| FinancialProfile |
The financial profile object for this contact.
| |
| FirstName |
Gets or sets the first (or given) name of this contact, if a person. Not set for Institute/Company records.
(Inherited from CContactBasic.) | |
| FullName |
Gets the full name of the contact/customer.
(Inherited from CContactBasic.) | |
| FunctionalTitle |
The functional (job) title of the contact. Functional title is used to group people with the same
job function but different actual job titles together for querying, sorting or reporting.
For example, contacts with a title of Secretary, Office Assistant, and Receptionist might all
get the Functional Title "Office Assistant".
| |
| Gender |
The Gender (sex) if the contact, if a person. Valid values are "M" for Male, "F" for female
or the empty string for unspecified or for companies.
| |
| HomePhone |
The home telephone number of the contact
| |
| Informal |
Gets or sets the informal or nickname of the contact. For example, FirstName = "Robert", the informal
name might be "Bob".
(Inherited from CContactBasic.) | |
| InstituteContactId |
The Contact ID of the institute/company for which this contact works (for people) or is a subsidiary of
(for institutes/companies)
| |
| InstituteCustomerTypeCode |
The Customer type of the institute
| |
| InstituteName |
Gets or sets the name of the institute/company for which the ship to customer works, or if the
customer is an institute/company, its name.
(Inherited from CContactBasic.) | |
| InstituteSort |
Gets the Institute name, optimized for sorting
(Inherited from CContactBasic.) | |
| IsInstitute |
Gets or sets an indicator of whether this contact is an institute/company (true) or a Person (false).
(Inherited from CContactBasic.) | |
| IsMember |
Indicates whether or not the contact is a member. A contact is a member if MemberRecord is true
and Status begins with "A"
| |
| JoinDate |
The date that the contact joined (became a member of) the organization
| |
| LastFirst | (Inherited from CContactBasic.) | |
| LastFirstInstitute |
Gets the contact's last and first name or the institute name if no last or first is available.
Calculated as LastName, FirstName. Like Doe, John or ABC Corp.
(Inherited from CContactBasic.) | |
| LastName |
Gets or sets the last name, family name or surname of this contact/customer, if a person. Not set for Institute/Company records.
(Inherited from CContactBasic.) | |
| MailCode |
Also known as "Address Code" this code may be assigned to contacts and addresses
(depending on system options) to allow them to be sorted together in mailings
| |
| MajorKey |
A second unique key (in addition to ContactId) that can optionally be assigned to contacts to
help in retrieving them via the iMIS search functionality. Usually something like
Social Security Number, License Number, Certification Number, Old Member ID, etc.
| |
| MemberStatusCode |
The membership status of the Contact
| |
| MemberStatusDate |
The date on which the MemberStatus was set to its current state
| |
| MiddleName |
Gets or sets the middle name of the contact/customer.
(Inherited from CContactBasic.) | |
| NoteCount |
The number of notes that exist for this contact
| |
| Notes |
Array of notes about this contact. Will be null if the contact has no notes.
| |
| PaidThroughDate |
The date through whcih this contact has paid membership dues.
| |
| PreferredBillAddress |
The CAddress that is the contact's preferred address for bills
| |
| PreferredMailAddress |
The CAddress that is the contact's preferred address for mailings
| |
| PreferredShipAddress |
The CAddress that is the contact's preferred address for shipping
| |
| Prefix |
Gets or sets the prefix (personal title) to the customer's name. Like Mr., Mrs., etc.
(Inherited from CContactBasic.) | |
| PreviousCustomerTypeCode |
The previous customer type (member type) before it was changed to its present value.
| |
| PrimarySubscription |
Gets the primary subscription associated with this contact
| |
| SicCode |
The Standard Industrial Classification (SIC) Code that best matches the one in which this contact
does business.
| |
| SortName |
Gets the name of the contact, optimized for sorting
(Inherited from CContactBasic.) | |
| SourceCode |
A character code indicating the source of this contact
| |
| SubscriptionCount |
The number of subscriptions associated with this contact
| |
| Subscriptions |
Array of subscriptions associated with this contact. Will be null if the contact has no notes.
| |
| Suffix |
Gets or sets the suffix to the customer's name. Like Sr., Jr., etc.
(Inherited from CContactBasic.) | |
| Title |
The job title of the contact. Like CEO, Staff Accountant, etc.
(Inherited from CContactBasic.) | |
| TollFreePhone |
Gets or sets the toll free telephone number of this contact. (A.K.A., 800 number)
(Inherited from CContactBasic.) | |
| UpdatedByUserId |
The login user id of the user who last updated this contact's record
| |
| UpdatedOn |
The date and time that this contact's record was last updated
| |
| UseMemberPricing |
Indicates whether or not to give this contact member pricing when doing product sales.
| |
| UserSecurity |
The security object associated with this Contact
| |
| WebsiteAddress |
The contact's website address. May include the http:// but does not need it unless it needs to
be https
| |
| WorkPhone |
The contact's telephone number at work
(Overrides CContactBasic..::..WorkPhone.) |