|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_6_1.IUnknown
org.virtualbox_6_1.IVirtualBoxErrorInfo
public class IVirtualBoxErrorInfo
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. ThegetNext()
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: {C1BCC6D5-7966-481D-AB0B-D0ED73E28135}
Field Summary |
---|
Fields inherited from class org.virtualbox_6_1.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
IVirtualBoxErrorInfo(java.lang.String wrapped,
org.virtualbox_6_1.ObjectRefManager objMgr,
org.virtualbox_6_1.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.Integer |
getResultDetail()
Optional result data of this error. |
java.lang.String |
getText()
Text description of the error. |
static IVirtualBoxErrorInfo |
queryInterface(IUnknown obj)
|
Methods inherited from class org.virtualbox_6_1.IUnknown |
---|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IVirtualBoxErrorInfo(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.jaxws.VboxPortType port)
Method Detail |
---|
public java.lang.Integer getResultCode()
public java.lang.Integer getResultDetail()
public java.lang.String getInterfaceID()
public java.lang.String getComponent()
public java.lang.String getText()
public IVirtualBoxErrorInfo getNext()
public static IVirtualBoxErrorInfo queryInterface(IUnknown obj)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |