DOFInterfaceException ClassOpenDOF Object Access Library
Defines an Exception as part of a DOFInterface.
Inheritance Hierarchy

SystemObject
  org.opendof.core.oalDOFInterfaceItem
    org.opendof.core.oalDOFInterfaceException

Namespace: org.opendof.core.oal
Assembly: dof-oal (in dof-oal.dll) Version: 7.0.1.2
Syntax

C#
[SerializableAttribute]
public class Exception : DOFInterfaceItem

The DOFInterfaceException type exposes the following members.

Constructors

  NameDescription
Protected methodDOFInterfaceException
Construct a typeless Exception.
Protected methodDOFInterfaceException(Int32, DOFType)
Construct a new Exception.
Protected methodDOFInterfaceException(DOFInterface, DOFTypeContext, DOFPacket)
Create an instance from serial form.
Top
Methods

  NameDescription
Public methodCompareTo
compareTo compares this Item with another object lexicographically.
(Inherited from DOFInterfaceItem.)
Public methodEquals (Inherited from DOFInterfaceItem.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode (Inherited from DOFInterfaceItem.)
Public methodgetInterface
Get the interface that this item belongs to.
(Inherited from DOFInterfaceItem.)
Public methodgetInterfaceID
Get the interface identifier.
(Inherited from DOFInterfaceItem.)
Public methodgetItemID
Get the item ID.
(Inherited from DOFInterfaceItem.)
Public methodgetItemType
Get the item type of PROPERTY, METHOD, EVENT or EXCEPTION.
(Inherited from DOFInterfaceItem.)
Public methodgetParameterCount
Get the number of Parameters for this Exception.
Public methodgetParameters
Get the Parameters for this Exception.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodmarshal (Overrides DOFInterfaceItemmarshal(DOFTypeContext, DOFPacket).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
The String representation of this Exception.
(Overrides DOFInterfaceItemToString.)
Top
Fields

  NameDescription
Protected fieldiface
The interface to which the item belongs.
(Inherited from DOFInterfaceItem.)
Protected fielditemID
The item identifier.
(Inherited from DOFInterfaceItem.)
Protected fieldparameters
The exception parameters.
Top
Remarks

Defines an Exception as part of a DOFInterface. Exceptions are used to convey problem behavior from a provider to a requester as a possible result of a requester action. For example, a requestor may invoke a DOFException.Method like CreatePizza(toppings), where one of the toppings is unavailable. The provider may then throw ToppingUnavailableException.
See Also

Reference

Invoke.respond(DOFProviderException)