FailureDefinition

Description:
Defines persistent information about a failure.

Remarks:
Each failure that can be potentially posted in Revit must be based on a FailureDefinition object that contains some persistent information about failure such as identity, severity, basic description text, types of resolution and default resolution. Each FailureMessage, which contains variable part of the information for a specific failure when it occurs, is created with a reference to a registered FailureDefinition. In order to be able to post a failure, one must define and register it via FailureDefinition object during Revit Application startup.

Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.FailureDefinition

public class FailureDefinition : IDisposable

Public Class FailureDefinition
	Implements IDisposable

public ref class FailureDefinition : IDisposable

type FailureDefinition = 
    class
        interface IDisposable
    end

Name	Return Type	Description	Inherited From
M AddResolutionType(FailureResolutionType, String, Type)	FailureDefinition	Adds a type of possible resolution for the failure.
M CreateFailureDefinition(FailureDefinitionId, FailureSeverity, String)	FailureDefinition	Creates an instance of a FailureDefinition.
M Dispose()	None	Releases all resources used by the FailureDefinition
M Equals	None	Determines whether the specified object is equal to the current object. (Inherited from Object )	Object
M GetApplicableResolutionTypes()	IList<FailureResolutionType>	Retrieves a list of resolution types applicable to the failure.
M GetDefaultResolutionType()	FailureResolutionType	Retrieves the default resolution type for the failure.
M GetDescriptionText()	String	Retrieves the description text of the failure.
M GetHashCode	None	Serves as the default hash function. (Inherited from Object )	Object
M GetResolutionCaption(FailureResolutionType)	String	Retrieves the caption for a specific resolution type.
M GetType	None	Gets the Type of the current instance. (Inherited from Object )	Object
M HasResolutions()	Boolean	Checks if the FailureDefinition has at least one resolution.
M IsResolutionApplicable(FailureResolutionType)	Boolean	Checks if the given resolution type is applicable to the failure.
M SetDefaultResolutionType(FailureResolutionType)	FailureDefinition	Sets the default resolution type for the failure.
M ToString	None	Returns a string that represents the current object. (Inherited from Object )	Object

Name	Return Type	Description	Inherited From
P IsValidObject	Boolean	Specifies whether the .NET object represents a valid Revit entity.
P Severity	FailureSeverity	The severity of the failure.