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

AFCase Methods

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

The AFCase type exposes the following members.

Methods

  NameDescription
Public method
Acknowledge(String, NullableAFTime)
Acknowledges a single AFEventFrame.
(Inherited from AFEventFrame.)
Public method
AddInput(AFAttribute)
Adds an attribute and its value at the time of the case to the result set.
Public method
AddInput(AFAttribute, AFValue)
Adds an attribute and a specified AFValue to the result set.
Public method
AddInput(AFAttribute, AFValue, UOM) Obsolete.
Adds an attribute and a specified value to the result set.
Public method
AddInput(AFAttribute, Object, UOM)
Adds an attribute and a specified value to the result set.
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
CheckOutCases
Check out the objects with the specified unique identifiers at the specified query date.
Public method
CollectElements
This method collects the elements that are active for this case.
Public method
CollectInputs
This method uses the AFAnalysisRule to obtain the input values necessary to start an analysis.
Public method
CollectInputs(AFCaseLog) Obsolete.
This method uses the AFAnalysisRule to obtain the input values necessary to start an analysis.
Public method
CollectTransfers
This method collects the transfers that are active for this case.
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
CreateTemporary
This method creates a temporary case from the current case.
Public method
Delete
Deletes this event frame from the AFDatabase.
(Inherited from AFEventFrame.)
Public methodStatic member
DeleteCases
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
FindCase(PISystem, Guid)
Retrieves the AFCase object with the specified unique identifier at the AFTime.MaxValue query date.
Public methodStatic member
FindCase(PISystem, Guid, Object)
Retrieves the AFCase object with the specified unique identifier at the specified query date.
Public methodStatic member
FindCases(PISystem, Guid, Object)
Performs a search within the PISystem to retrieve a collection of AFCase objects with the specified list of unique identifiers.
Public methodStatic member
FindCases(AFAnalysis, String, AFSearchField, AFSortField, AFSortOrder, Int32)
Performs a text search within the AFDatabase to retrieve a collection of AFCase objects that match the specified query string.
Public methodStatic member
FindCases(AFAnalysis, Object, Int32, AFEventFrameSearchMode, String, AFCategory, AFElementTemplate)
Retrieves a list of AFCase objects limited to the specified count beginning at the requested time in the specified direction.
Public methodStatic member
FindCases(AFAnalysis, Object, Int32, Boolean, String, AFCategory, AFElementTemplate) Obsolete.
Retrieves a list of AFCase objects limited to the specified count beginning at the requested start time in the specified direction.
Public methodStatic member
FindCases(AFAnalysis, AFSearchMode, Object, Object, String, AFCategory, AFElementTemplate, AFSortField, AFSortOrder, Int32) Obsolete.
Retrieves a list of AFCase objects that match the specified filtering conditions.
Public method
GetAdjustments
This method returns a collection of AFAdjustment objects for all the Results within the AFCase.
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
GetConnectedElements(AFBaseElement)
This method returns a collection of AFBaseElement objects which are connected to the specified element (or child element) within the case.
Public method
GetConnectedElements(AFBaseElement, AFPortType)
This method returns a collection of AFBaseElement objects which are connected to the specified element (or child element) through a port of the specified type within the case.
Public method
GetConnectedElements(AFBaseElement, String)
This method returns a collection of AFBaseElement objects which are connected to the specified element and port within the case.
Public method
GetConnections(AFBaseElement)
This method returns a collection of AFConnection objects representing a connection between the specified element (or child element) and another element within the case.
Public method
GetConnections(AFBaseElement, AFPortType)
This method returns a collection of AFConnection objects with the specified port type representing a connection between the specified element (or child element) and another element within the case.
Public method
GetConnections(AFBaseElement, String)
This method returns a collection of AFConnection objects with the specified port name representing a connection between the specified element and another element within the case.
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
GetLayers
This method returns a collection of AFLayer objects for the specified element representing all the active layers of the case which contain the element.
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
GetResult
This method gets the result for the specified attribute.
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
IsActiveElement
Determines if the specified AFElement is active within the case.
Public method
IsActiveTransfer
Determines if the specified AFTransfer is active within the case.
Public method
IsTraced
Indicates if a specified level is being traced.
Public method
IsTypeOf
Checks if the current AFBaseElement is derived from the specified AFElementTemplate.
(Inherited from AFBaseElement.)
Public methodStatic member
LoadCases(IListAFCase)
Loads the specified list AFCase objects.
Public methodStatic member
LoadCases(PISystem, Guid, Object)
Loads the AFCase 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
Publish
The output AFAttribute values of the analysis case run are published to the locations specified by the attribute's data reference configuration.
Public method
PublishValue(AFAttribute, AFValue)
Write the specified value of the AFAttribute directly to the data reference source using the specified AFValue object.
Public method
PublishValue(AFAttribute, Object, UOM)
Write the specified value of the AFAttribute directly to the data reference source with the specified unit-of-measure at the case's EndTime.
Public method
Refresh
Refreshes the client with any changes that have been made to the object since loaded.
Public method
Reset(AFAttribute)
This method resets an attribute in an analysis case.
Public method
Reset(AFResult)
This method resets an attribute for the specified AFResult in an analysis case.
Public method
Reset(Boolean, Boolean)
This method resets the input and/or output results generated in an analysis case.
Public method
Reset(Boolean, Boolean, AFAttribute) Obsolete.
This method resets the results generated in an analysis case.
Public method
Run
This method uses the AFAnalysisRule to execute the analysis and generate analysis results.
Public method
Run(AFCaseLog) Obsolete.
This method uses the AFAnalysisRule to execute the analysis and generate analysis results.
Public method
SetEndTime
Set the time that represents the time that the period ended.
(Inherited from AFEventFrame.)
Public method
SetStartTime
Set the time that represents the time that the period started.
(Overrides AFEventFrameSetStartTime(Object).)
Public method
ToString
Returns a String that represents the current object.
(Overrides AFObjectToString.)
Public method
TraceData
Output a data trace event.
Public method
TraceDetail
Output a detail trace event.
Public method
TraceError
Output an error trace event.
Public method
TraceEvent(AFTraceSwitchLevel, String)
Output a trace event with a message.
Public method
TraceEvent(AFTraceSwitchLevel, String, Int32)
Output a trace event with a message and a duration.
Public method
TraceEvent(AFTraceSwitchLevel, String, Object)
Output a trace event as a formatted message with a variable number of arguments.
Public method
TraceInformation
Output an information trace event.
Public method
TraceSummary
Output a summary trace event.
Public method
TraceWarning
Output a warning trace event.
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