Click or drag to resize

PFExternalConnection Class

Represents a connection between a Packflow content-type and an external content.
Inheritance Hierarchy

Namespace:  Packflow.Core
Assembly:  MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax
C#
public sealed class PFExternalConnection : PFBaseObject

The PFExternalConnection type exposes the following members.

Constructors
  NameDescription
Public methodPFExternalConnection
Top
Properties
  NameDescription
Public propertyAddEventOnSync
Gets or sets a value indicating whether a PFItemEvent should be created for the synchronized item on each synchronization.
Public propertyAllowItemDeletion
Gets or sets a value indicating whether a synchronized item, no more found in the data source, should be deleted in Packflow. If False, the item will not be modified or deleted.
Public propertyApplicationContext
Gets or sets the application context. This context will be assigned to synchronized items.
Public propertyApplicationContextGuid
Gets the application context GUID.
Public propertyApplicationContextId
Gets the application context id.
Public propertyBatchSize
Gets or sets the number of elements (rows, items) loaded by query to the data source.
Public propertyBeforeSaveValues
Gets the previous values of modified fields before the latest Save.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyBindings
Gets the list of bindings between items fields and the source data.
Public propertyCanDelete
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.)
Public propertyCanRead
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.)
Public propertyCanUpdate
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.)
Public propertyCreated
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.)
Public propertyCreatedAt
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.)
Public propertyCreatedBy
Gets the user who created this object in the database.
(Inherited from PFBaseObject.)
Public propertyData
Gets the data collection of this object.
(Inherited from PFBaseObject.)
Public propertyDateObjectCreation
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.)
Public propertyDeleted
True if this object is flagged as deleted.
(Inherited from PFBaseObject.)
Public propertyDeletedAt
Date of the suppression of this object.
(Inherited from PFBaseObject.)
Public propertyDeletedBy
The user who deleted this object.
(Inherited from PFBaseObject.)
Public propertyDescription
Gets or sets the description.
Public propertyEnabled
Gets or sets a value indicating whether this connection can be used to synchronize items.
Public propertyEnableVersionMergeToResolveSaveConflicts
Gets a value indicating whether versions can be merged to resolve save conflicts. If an object is saved with an older version than the last persisted (in database), the system will try to merge the versions values (if no conflicts between values) and will then save the merged item to database. Note : this setting is NOT persisted and will affect this object instance only.
(Inherited from PFBaseObject.)
Public propertyExists
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.)
Public propertyFrequency
Gets the frequency of automatic synchronizations.
Public propertyGuid
Gets the GUID identifying this object. Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.)
Public propertyHasPendingModifications
Checks if there is pending changes. Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.)
Public propertyHasPendingPermissionsModifications
Checks if there is pending modifications in permissions. Will compute permissions (RUD) and check if there is differences with current persisted permissions.
(Inherited from PFBaseObject.)
Public propertyId
Gets the id identifying this object. Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.)
Public propertyKeepBeforeSaveValues
Gets or sets a value indicating whether the Save should keep a collection of the modified fields previous values.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyLastSynchronization
Gets the date of the last synchronization.
Public propertyLocation
Gets or sets the location of the data source targeted by this connection.
Public propertyLogger
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.)
Public propertyLogIdentification
Gets a technical text representing this object.
(Inherited from PFBaseObject.)
Public propertyName
Gets or sets the name, text representing the connection.
Public propertyOrderNo
Gets or sets the order number, used globally across all content-types to determine the order of synchronization.
Public propertyParentApplication
Gets the parent application.
Public propertyParentContentType
Gets the parent content-type.
Public propertyPermissionContext
Gets an object calculating permissions on demand.
Public propertyPermissions
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.)
Public propertySchema
Gets the schema of the data source, representing the source’s data definition on its last synchronization.

This object is used during the setup of a connection's binding to know which field can be bound with which external data.

Public propertySecondPass
Gets or sets a value indicating whether this connection should be synchronized a second time after a global synchronization. This allows to handle two inter-referenced content.
Public propertySite
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.)
Public propertySkipRequiredFieldCheck
Gets or sets a value indicating whether required fields can be left empty when saving an item during a synchronization.
Public propertySynchronizationPermission
Gets or sets an object describing who can synchronize items from the UI (navigation and forms).
Public propertyType
Gets or sets the type of targeted source targeted by this connection.
Public propertyUpdatedAt
Gets the date of the last update of this object.
(Inherited from PFBaseObject.)
Public propertyUpdatedBy
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.)
Public propertyVersionNumber
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.)
Top
Methods
  NameDescription
Public methodCurrentUserHasSynchronizationPermission
Checks if the current user can synchronize the items from the UI (navigation and forms). This is based on the SynchronizationPermission value.
Public methodDelete
Flags this object as deleted.

If it fails, throws an error.

If the object could not be deleted because it does not yet exist in database, returns false.

If successful, returns true.

(Inherited from PFBaseObject.)
Public methodRunInTransactionArea
Runs a code with a transaction on object connection. If there is no current transaction and if the code succeed, transaction is committed. If an exception is thrown, transaction is rollback.
(Inherited from PFBaseObject.)
Public methodSave
Applies the data of this object in the database.
(Overrides PFBaseObjectSave.)
Public methodSynchronize
Synchronizes the parent content with the external content targeted by this connection.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpdateSchema
Updates the Schema property using the current location.
Top
Fields
  NameDescription
Public fieldStatic memberDefaultBatchSize
Default size of the successive batches of external data imported in Packflow.
Public fieldStatic memberFieldName_AddEventOnSync
Column name in database.
Public fieldStatic memberFieldName_AllowItemDeletion
Column name in database.
Public fieldStatic memberFieldName_ApplicationContextGuid
Column name in database.
Public fieldStatic memberFieldName_ApplicationContextId
Column name in database.
Public fieldStatic memberFieldName_ApplicationId
Column name in database.
Public fieldStatic memberFieldName_BatchSize
Column name in database.
Public fieldStatic memberFieldName_ContentTypeId
Column name in database.
Public fieldStatic memberFieldName_Description
Column name in database.
Public fieldStatic memberFieldName_Enabled
Column name in database.
Public fieldStatic memberFieldName_LastSynchronization
Column name in database.
Public fieldStatic memberFieldName_Name
Column name in database.
Public fieldStatic memberFieldName_OrderNo
Column name in database.
Public fieldStatic memberFieldName_SecondPass
Column name in database.
Public fieldStatic memberFieldName_SerializedBindings
Column name in database.
Public fieldStatic memberFieldName_SerializedFrequency
Column name in database.
Public fieldStatic memberFieldName_SerializedLocation
Column name in database.
Public fieldStatic memberFieldName_SerializedSchema
Column name in database.
Public fieldStatic memberFieldName_SkipRequiredFieldCheck
Column name in database.
Public fieldStatic memberFieldName_SynchronizationPermission
Column name in database.
Public fieldStatic memberFieldName_Type
Column name in database.
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also