IAFTransactable Interface
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
This interface defines the properties and methods for objects which support being transacted.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public interface IAFTransactable : IAFChangedEvent
Public Interface IAFTransactable Inherits IAFChangedEvent Dim instance As IAFTransactable
public interface class IAFTransactable : IAFChangedEvent
type IAFTransactable = interface interface IAFChangedEvent end
The IAFTransactable type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | CheckOutInfo |
This read-only property returns the checked out status information for the object.
|
| CreationDate |
This read-only property returns the time when the object was first created.
|
| IsDirty |
Indicates whether the object or one of its sub-objects have been
modified since the last save in to persistent storage.
|
| IsNew |
Indicates whether the object is new and has never been saved to persistent storage.
|
| IsSystemDefined |
Indicates if the IAFTransactable object is system defined.
|
| ModifyDate |
This read-only property returns the time when the object's configuration was last modified.
|
| RevisionNumber |
This read-only property returns the change revision number of the object.
|
Methods
| Name | Description | |
|---|---|---|
  | ApplyChanges |
This method applies the changes to the object and makes
those changes available to other objects for the current user.
|
| CheckIn |
This method checks in (commits) all the changes to the object by saving
the information to persistent storage.
|
| CheckOut |
This method locks the object so that its configuration can be modified.
|
| Refresh |
Refreshes the client with any changes that have been made to the object since loaded.
|
| UndoCheckOut |
This method discards all the changes to the object and all sub-objects since the
last call to CheckOut. Any changes since the check out will be lost.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
Event is raised when the object or one of its sub-objects is changed.
(Inherited from IAFChangedEvent.) |
Remarks
Objects that support transacted operations like CheckOut and CheckIn
implement this interface. Objects that implement this interface must be checked out before making
any changes to their configuration. This prevents multiple users from attempting to make changes
to the same object at the same time.