org.virtualbox_4_2
Class IVirtualBoxErrorInfo

java.lang.Object
  extended by org.virtualbox_4_2.IUnknown
      extended by org.virtualbox_4_2.IVirtualBoxErrorInfo

public class IVirtualBoxErrorInfo
extends IUnknown

The IVirtualBoxErrorInfo interface represents extended error information. Extended error information can be set by VirtualBox components after unsuccessful or partially successful method invocation. This information can be retrieved by the calling party as an IVirtualBoxErrorInfo object and then shown to the client in addition to the plain 32-bit result code. In MS COM, this interface extends the IErrorInfo interface, in XPCOM, it extends the nsIException interface. In both cases, it provides a set of common attributes to retrieve error information. Sometimes invocation of some component's method may involve methods of other components that may also fail (independently of this method's failure), or a series of non-fatal errors may precede a fatal error that causes method failure. In cases like that, it may be desirable to preserve information about all errors happened during method invocation and deliver it to the caller. The getNext() attribute is intended specifically for this purpose and allows to represent a chain of errors through a single IVirtualBoxErrorInfo object set after method invocation. NOTE: errors are stored to a chain in the reverse order, i.e. the initial error object you query right after method invocation is the last error set by the callee, the object it points to in the next attribute is the previous error and so on, up to the first error (which is the last in the chain). Interface ID: {F91E6E91-49E1-4FD2-B21E-269003350D06}


Field Summary
 
Fields inherited from class org.virtualbox_4_2.IUnknown
obj, port
 
Constructor Summary
IVirtualBoxErrorInfo(java.lang.String wrapped, org.virtualbox_4_2.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.String getComponent()
          Name of the component that generated the error.
 java.lang.String getInterfaceID()
          UUID of the interface that defined the error.
 IVirtualBoxErrorInfo getNext()
          Next error object if there is any, or null otherwise.
 java.lang.Integer getResultCode()
          Result code of the error.
 java.lang.String getText()
          Text description of the error.
static IVirtualBoxErrorInfo queryInterface(IUnknown obj)
           
 
Methods inherited from class org.virtualbox_4_2.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IVirtualBoxErrorInfo

public IVirtualBoxErrorInfo(java.lang.String wrapped,
                            org.virtualbox_4_2.jaxws.VboxPortType port)
Method Detail

getResultCode

public java.lang.Integer getResultCode()
Result code of the error. Usually, it will be the same as the result code returned by the method that provided this error information, but not always. For example, on Win32, CoCreateInstance() will most likely return E_NOINTERFACE upon unsuccessful component instantiation attempt, but not the value the component factory returned. Value is typed 'long', not 'result', to make interface usable from scripting languages. NOTE: In MS COM, there is no equivalent. In XPCOM, it is the same as nsIException::result.

Returns:
Integer

getInterfaceID

public java.lang.String getInterfaceID()
UUID of the interface that defined the error. NOTE: In MS COM, it is the same as IErrorInfo::GetGUID, except for the data type. In XPCOM, there is no equivalent.

Returns:
String

getComponent

public java.lang.String getComponent()
Name of the component that generated the error. NOTE: In MS COM, it is the same as IErrorInfo::GetSource. In XPCOM, there is no equivalent.

Returns:
String

getText

public java.lang.String getText()
Text description of the error. NOTE: In MS COM, it is the same as IErrorInfo::GetDescription. In XPCOM, it is the same as nsIException::message.

Returns:
String

getNext

public IVirtualBoxErrorInfo getNext()
Next error object if there is any, or null otherwise. NOTE: In MS COM, there is no equivalent. In XPCOM, it is the same as nsIException::inner.

Returns:
org.virtualbox_4_2.IVirtualBoxErrorInfo

queryInterface

public static IVirtualBoxErrorInfo queryInterface(IUnknown obj)