Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

TABLE OF CONTENTS

AFTransfer Methods

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedNov 18, 2025
  • 9 minute read
AFTransfer Methods

The AFTransfer type exposes the following members.

Methods

  NameDescription
Public method
Acknowledge(String, NullableAFTime)
Acknowledges a single AFEventFrame.
(Inherited from AFEventFrame.)
Public methodCode example
ApplyChanges
This method applies the changes to the object and makes those changes available to other objects for the current user.
Public method
CaptureValues
Capture and cache the AFAttribute values with a AFDataReference using the default non-cached data provider.
(Inherited from AFEventFrame.)
Public method
CaptureValues(IAFDataProvider)
Capture and cache the AFAttribute values with a AFDataReference using the specified IAFDataProvider.
(Inherited from AFEventFrame.)
Public method
ChangeReferenceType
Change the existing AFReferenceType between a child event frame.
(Inherited from AFEventFrame.)
Public methodCode example
CheckIn
This method checks in (commits) all the changes to the object by saving the information to persistent storage.
Public method
CheckOut
This method locks the object so that its configuration can be modified.
Public methodStatic member
CheckOutTransfers
Check out the objects with the specified unique identifiers at the specified query date.
Public method
CompareTo(Object)
Compares this instance with a specified Object.
(Inherited from AFEventFrame.)
Public method
CompareTo(AFEventFrame)
Compares this instance with a specified AFEventFrame.
(Inherited from AFEventFrame.)
Public method
CompareTo(AFObject)
Compares this instance with a specified AFObject.
(Inherited from AFObject.)
Public method
CreateElementTemplate
Create an AFElementTemplate based upon the element.
(Inherited from AFBaseElement.)
Public method
Delete
Deletes this event frame from the AFDatabase.
(Inherited from AFEventFrame.)
Public methodStatic member
DeleteTransfers
Delete the objects with the specified unique identifiers.
Public method
Equals(Object)
Determines whether the specified Object is equal to the current object.
(Inherited from AFEventFrame.)
Public method
Equals(AFEventFrame)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFEventFrame.)
Public method
Equals(AFObject)
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.)
Public methodStatic member
FindTransfer(PISystem, Guid)
Retrieves the AFTransfer object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic member
FindTransfer(PISystem, Guid, Object)
Retrieves the AFTransfer object with the specified unique identifier at the specified query date.
Public methodStatic member
FindTransfers(PISystem, Guid, Object)
Performs a search within the PISystem to retrieve a collection of AFTransfer objects with the specified list of unique identifiers.
Public methodStatic member
FindTransfers(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32)
Performs a text search within the AFDatabase to retrieve a collection of AFTransfer objects that match the specified query string.
Public methodStatic member
FindTransfers(AFDatabase, Object, Int32, AFEventFrameSearchMode, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate) Obsolete.
Retrieves a list of AFTransfer objects limited to the specified count beginning at the requested start time in the specified direction.
Public methodStatic member
FindTransfers(AFDatabase, Object, Int32, Boolean, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate) Obsolete.
Retrieves a list of AFTransfer objects limited to the specified count beginning at the requested start time in the specified direction.
Public methodStatic member
FindTransfers(AFDatabase, AFSearchMode, Object, Object, String, AFBaseElement, AFBaseElement, AFCategory, AFElementTemplate, AFSortField, AFSortOrder, Int32) Obsolete.
Retrieves a list of AFTransfer objects that match the specified filtering conditions.
Public method
GetAnnotations
Retrieves a collection of existing AFAnnotation objects belonging to this AFBaseElement.
(Inherited from AFBaseElement.)
Public method
GetAttributeByTrait
Retrieves the child AFAttribute with the specified AFAttributeTrait.
(Inherited from AFBaseElement.)
Public method
GetAttributesByTrait
Retrieves a list of child AFAttribute objects identified by the specified list of attribute traits.
(Inherited from AFBaseElement.)
Public method
GetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from AFEventFrame.)
Public method
GetParents(AFCategory)
Retrieves a collection of AFEventFrame objects that reference this event frame using the specified AFCategory.
(Inherited from AFEventFrame.)
Public method
GetParents(AFReferenceType)
Retrieves a collection of AFEventFrame objects that reference this event frame using the specified AFReferenceType.
(Inherited from AFEventFrame.)
Public method
GetPath
Returns the full path to the object, using just the names.
(Inherited from AFObject.)
Public method
GetPath(AFObject)
Returns the path to the object relative from another object.
(Inherited from AFObject.)
Public method
GetPath(AFEncodeType, AFObject)
Returns the path to the object relative from another object, using the name and/or id as specified by encodeType.
(Inherited from AFObject.)
Public method
GetPaths
Get all the relative paths to this AFEventFrame.
(Inherited from AFEventFrame.)
Public method
GetReferenceTypes
Retrieves a collection of all AFReferenceType objects that represent types of references from this event frame to its child event frames.
(Inherited from AFEventFrame.)
Public method
GetReferenceTypes(AFEventFrame)
Retrieves a collection of AFReferenceType objects that represent types of references between this event frame and the specified related event frame.
(Inherited from AFEventFrame.)
Public method
GetSecurity
Gets the AFSecurity information of the specified security item associated with the object.
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IsTypeOf
Checks if the current AFBaseElement is derived from the specified AFElementTemplate.
(Inherited from AFBaseElement.)
Public method
IsValidDestination(AFPort, String)
This method checks if the specified port is valid as the destination of this transfer.
Public method
IsValidDestination(AFElement, AFPort, String) Obsolete.
This method checks if the specified port is valid as the destination of this transfer.
Public method
IsValidSource(AFPort, String)
This method checks if the specified port is valid as the source of this transfer.
Public method
IsValidSource(AFElement, AFPort, String) Obsolete.
This method checks if the specified port is valid as the source of this transfer.
Public methodStatic member
LoadTransfers(IListAFTransfer)
Loads the specified list AFTransfer objects.
Public methodStatic member
LoadTransfers(PISystem, Guid, Object)
Loads the AFTransfer objects with the specified unique identifiers at the specified query date.
Public method
Lock
Locks this event frame so that no further changes can be made.
(Inherited from AFEventFrame.)
Public method
Persist
This method returns the persistence string for the object.
(Inherited from AFObject.)
Public method
Refresh
Refreshes the client with any changes that have been made to the object since loaded.
Public method
SetDestination(AFPort)
Set the element and port that are the destination of the transfer.
Public method
SetDestination(AFElement, AFPort) Obsolete.
Set the element and port that are the destination of the transfer.
Public method
SetEndTime
Set the time that represents the time that the period ended.
(Inherited from AFEventFrame.)
Public method
SetSource(AFPort)
Set the element and port that are the source of the transfer.
Public method
SetSource(AFElement, AFPort) Obsolete.
Set the element and port that are the source of the transfer.
Public method
SetStartTime
Set the time that represents the time that the period started.
(Inherited from AFEventFrame.)
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFObject.)
Public method
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.
Public method
Unlock
Unlocks a locked event frame so that further changes can be made.
(Inherited from AFEventFrame.)

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in