ICustomer¶
- class ICustomer¶
Bases:
ImpactCOMWrapperBase- Description:
Represents a customer in the database.
Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance
- property active¶
Gets Active.
- Description:
Indicates whether the customer is active.
- Remarks:
Inactive customers are hidden from some parts of the Impact interface; for example when assigning a project to a customer. Introduced in Impact 6.0.0.67. Until Impact 11.0.0.32, this was a read-only property.
- Returns:
The value of Active.
- Return type:
active (bool)
- property addresses¶
Gets Addresses.
- Description:
Returns the IAddresses associated with the customer.
- Remarks:
Introduced in Impact 11.0.0.23
- Returns:
The value of Addresses.
- Return type:
- property code¶
Gets Code.
- Description:
The code of the customer.
- Returns:
The value of Code.
- Return type:
code (str)
- property contacts¶
Gets Contacts.
- Description:
An ICustomerContacts collection representing all the contacts associated with this item.
- Remarks:
Introduced in Impact 6.0.0.83.
- Returns:
The value of Contacts.
- Return type:
- property documents¶
Gets Documents.
- Description:
An IDocuments collection representing all the documents associated with this item.
- Returns:
The value of Documents.
- Return type:
- property formatted_name¶
Gets formatted_name.
- Description:
The formatted name of the customer.
- Returns:
The value of formatted_name.
- Return type:
formatted_name (str)
- property key¶
Gets Key.
- Description:
The key of the customer.
- Returns:
The value of Key.
- Return type:
key (int)
- property name¶
Gets Name.
- Description:
The name of the customer.
- Returns:
The value of Name.
- Return type:
name (str)
- property sites¶
Gets Sites.
- Description:
An ICustomerSites object representing the sites this customer is visible to.
- Remarks:
If customer sites are disabled this function returns null.
- Returns:
The value of Sites.
- Return type:
- property values¶
Gets Values.
- Description:
An IDatabaseValues object that can be used to read/write the customers associated database values.
- Remarks:
The Values object can be used to directly read/write database values, extreme care should be taken when using this object.
- Returns:
The value of Values.
- Return type:
- delete()¶
- Description:
Deletes the customer from the database.
- Returns:
If successful this method returns true otherwise false.
- refresh()¶
- Description:
Refresh the customer information from the database.