org.virtualbox_4_2.IRuntimeErrorEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of vboxjws Show documentation
VirtualBox Client API 4.2.8
There is a newer version: 4.2.8

/*
 *  Copyright (C) 2010-2011 Oracle Corporation
 *
 *  This file is part of the VirtualBox SDK, as available from
 *  http://www.virtualbox.org.  This library is free software; you can
 *  redistribute it and/or modify it under the terms of the GNU Lesser General
 *  Public License as published by the Free Software Foundation, in version 2.1
 *  as it comes in the "COPYING.LIB" file of the VirtualBox SDK distribution.
 *  This library is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 *  License for more details.
 *
 * IRuntimeErrorEvent.java
 *
 * DO NOT EDIT! This is a generated file.
 * Generated from: src/VBox/Main/idl/VirtualBox.xidl (VirtualBox's interface definitions in XML)
 * Generator: src/VBox/Main/glue/glue-java.xsl
 */

package org.virtualbox_4_2;

import org.virtualbox_4_2.jaxws.*;
import javax.xml.ws.*;
import java.util.List;

/**

      Notification when an error happens during the virtual
      machine execution.

      There are three kinds of runtime errors:
      fatal
non-fatal with retry
non-fatal warnings
Fatal errors are indicated by the  fatal parameter set
      to  true. In case of fatal errors, the virtual machine
      execution is always paused before calling this notification, and
      the notification handler is supposed either to immediately save
      the virtual machine state using {@link org.virtualbox_4_2.IConsole#saveState()}
      or power it off using {@link org.virtualbox_4_2.IConsole#powerDown()}.
      Resuming the execution can lead to unpredictable results.

      Non-fatal errors and warnings are indicated by the
       fatal parameter set to  false. If the virtual machine
      is in the Paused state by the time the error notification is
      received, it means that the user can try to resume the machine
      execution after attempting to solve the problem that caused the
      error. In this case, the notification handler is supposed
      to show an appropriate message to the user (depending on the
      value of the  id parameter) that offers several actions such
      as Retry, Save or Power Off. If the user
      wants to retry, the notification handler should continue
      the machine execution using the {@link org.virtualbox_4_2.IConsole#resume()}
      call. If the machine execution is not Paused during this
      notification, then it means this notification is a warning
      (for example, about a fatal condition that can happen very soon);
      no immediate action is required from the user, the machine
      continues its normal execution.

      Note that in either case the notification handler
      must not perform any action directly on a thread
      where this notification is called. Everything it is allowed to
      do is to post a message to another thread that will then talk
      to the user and take the corresponding action.

      Currently, the following error identifiers are known:
      "HostMemoryLow"
"HostAudioNotResponding"
"VDIStorageFull"
"3DSupportIncompatibleAdditions"
Interface ID: {883DD18B-0721-4CDE-867C-1A82ABAF914C}
*/
public class IRuntimeErrorEvent extends IEvent {

    public IRuntimeErrorEvent(String wrapped, VboxPortType port) {
          super(wrapped, port);
    }
/**

        Whether the error is fatal or not.
      
@return Boolean

*/
    public Boolean getFatal() {
      try {
         Boolean retVal = port.iRuntimeErrorEventGetFatal(obj);
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
/**

        Error identifier.
      
@return String

*/
    public String getId() {
      try {
         String retVal = port.iRuntimeErrorEventGetId(obj);
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
/**

        Optional error message.
      
@return String

*/
    public String getMessage() {
      try {
         String retVal = port.iRuntimeErrorEventGetMessage(obj);
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
    public static IRuntimeErrorEvent queryInterface(IUnknown obj) {
       return obj == null ?  null : new IRuntimeErrorEvent(obj.getWrapped(), obj.getRemoteWSPort());
    }
}