Class ServerException

Represents an exception that was returned from the server as a SOAP fault.

Inheritance

System.Object

System.Exception

ServerException

NoItemsFoundException

ValidationException

ValidationReportException

Inherited Members

System.Exception.GetBaseException()

System.Exception.Data

System.Exception.HelpLink

System.Exception.HResult

System.Exception.InnerException

System.Exception.Message

System.Exception.Source

System.Exception.StackTrace

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Innovator.Client

Assembly: Innovator.Client.dll

Syntax

public class ServerException : Exception, IAmlNode

Remarks

To create a new instance of this class, use ServerException(String) or one of the other overloads

Constructors

ServerException(Element, String, Command)

Initializes a new instance of the ServerException class.

Declaration

public ServerException(Element fault, string database, Command query)

Parameters

Type	Name	Description
Element	fault	The fault element.
System.String	database	The database where the exception originated.
Command	query	The query which was executed when the error was returned.

ServerException(String, Int32)

Initializes a new instance of the ServerException class.

Declaration

protected ServerException(string message, int code)

Parameters

Type	Name	Description
System.String	message	The message.
System.Int32	code	The fault code.

ServerException(String, Int32, Exception)

Initializes a new instance of the ServerException class.

Declaration

protected ServerException(string message, int code, Exception innerException)

Parameters

Type	Name	Description
System.String	message	The message.
System.Int32	code	The fault code.
System.Exception	innerException	The inner exception.

Fields

_database

The name of the database where the excepton originated

Declaration

protected string _database

Field Value

Type	Description
System.String

_fault

The AML fault element from the SOAP message

Declaration

protected Element _fault

Field Value

Type	Description
Element

_query

The query which was executed when the error was returned

Declaration

protected Command _query

Field Value

Type	Description
Command

Properties

Database

Gets the name of the database where the excepton originated

Declaration

public string Database { get; }

Property Value

Type	Description
System.String

Fault

Gets the AML fault element from the SOAP message

Declaration

public IElement Fault { get; }

Property Value

Type	Description
IElement

FaultCode

Gets or sets the (generally numeric) fault code.

Declaration

public string FaultCode { get; set; }

Property Value

Type	Description
System.String

Query

Gets the query which was executed when the error was returned

Declaration

public string Query { get; }

Property Value

Type	Description
System.String

Methods

AsResult()

Creates a new result composed of this exception

Declaration

public IReadOnlyResult AsResult()

Returns

Type	Description
IReadOnlyResult

CreateReader()

Creates an System.Xml.XmlReader for reading through the exception SOAP data

Declaration

public XmlReader CreateReader()

Returns

Type	Description
System.Xml.XmlReader

ToAml()

Renders the exception as an AML string

Declaration

public string ToAml()

Returns

Type	Description
System.String	An AML string

ToAml(XmlWriter, AmlWriterSettings)

Write the node to the specified System.Xml.XmlWriter as AML

Declaration

public void ToAml(XmlWriter writer, AmlWriterSettings settings)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	System.Xml.XmlWriter to write the node to
AmlWriterSettings	settings	Settings controlling how the node is written

Implements

IAmlNode.ToAml(XmlWriter, AmlWriterSettings)

ToString()

Returns a System.String that represents this instance consisting of the exception message and full stack trace

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

Overrides

System.Exception.ToString()

Extension Methods

ItemExtensions.ToAml(IAmlNode, AmlWriterSettings)

ItemExtensions.ToAml(IAmlNode, XmlWriter)

ItemExtensions.ToXml(IAmlNode)