ISite¶

class ISite¶

Bases: ImpactCOMWrapperBase

Summary:: Represents a database site.

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.

Summary:: Indicates whether the site is active in an Enterprise system
Remarks:: Introduced in Impact 10.0.0.47.

Returns:: The value of Active.
Return type:: active (bool)

property addresses¶

Gets Addresses.

Summary:: Returns the IAddresses associated with the site.
Remarks:: Introduced in Impact 11.0.0.23

Returns:: The value of Addresses.
Return type:: addresses (IAddresses)

property customers¶

Gets Customers.

Summary:: Gets an ICustomers collection for all customers assigned to this site.
Remarks:: If customer_sites are disabled this property is null.

Returns:: The value of Customers.
Return type:: customers (ICustomers)

property description¶

Gets Description.

Summary:: Returns the description of the site.

Returns:: The value of Description.
Return type:: description (str)

Examples:

Inspecting Database and MTS Sites

property documents¶

Gets Documents.

Summary:: An IDocuments collection representing all the documents associated with this item.

Returns:: The value of Documents.
Return type:: documents (IDocuments)

Examples:

Creating Site Documents

property full_name¶

Gets full_name.

Summary:: Returns the name of the site.

Returns:: The value of full_name.
Return type:: full_name (str)

Examples:

Inspecting Database and MTS Sites

property key¶

Gets Key.

Summary:: Returns the database key of the site in the SITES table.

Returns:: The value of Key.
Return type:: key (int)

Examples:

Inspecting Database and MTS Sites

property values¶

Gets Values.

Summary:: An IDatabaseValues object that can be used to read/write the sites 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:: values (IDatabaseValues)

isNone()¶: Checks if the COM object is None. This is useful for determining if the wrapper has been initialized with a valid COM object.

refresh()¶

Summary:: Refreshes the site information from the database.

Examples

Inspecting Database and MTS Sites