org.virtualbox_5_2
Class IVirtualSystemDescription

java.lang.Object
  extended by org.virtualbox_5_2.IUnknown
      extended by org.virtualbox_5_2.IVirtualSystemDescription

public class IVirtualSystemDescription
extends IUnknown

Represents one virtual system (machine) in an appliance. This interface is used in theIAppliance.getVirtualSystemDescriptions()array. AfterIAppliance.interpret()has been called, that array contains information about how the virtual systems described in the OVF should best be imported into VirtualBox virtual machines. SeeIAppliancefor the steps required to import an OVF into VirtualBox. Interface ID: {316C99A2-405D-41AF-8508-46889144D067}


Field Summary
 
Fields inherited from class org.virtualbox_5_2.IUnknown
obj, objMgr, port
 
Constructor Summary
IVirtualSystemDescription(java.lang.String wrapped, org.virtualbox_5_2.ObjectRefManager objMgr, org.virtualbox_5_2.jaxws.VboxPortType port)
           
 
Method Summary
 void addDescription(VirtualSystemDescriptionType type, java.lang.String VBoxValue, java.lang.String extraConfigValue)
          This method adds an additional description entry to the stack of already available descriptions for this virtual system.
 java.lang.Long getCount()
          Return the number of virtual system description entries.
 void getDescription(Holder<java.util.List<VirtualSystemDescriptionType>> types, Holder<java.util.List<java.lang.String>> refs, Holder<java.util.List<java.lang.String>> OVFValues, Holder<java.util.List<java.lang.String>> VBoxValues, Holder<java.util.List<java.lang.String>> extraConfigValues)
          Returns information about the virtual system as arrays of instruction items.
 void getDescriptionByType(VirtualSystemDescriptionType type, Holder<java.util.List<VirtualSystemDescriptionType>> types, Holder<java.util.List<java.lang.String>> refs, Holder<java.util.List<java.lang.String>> OVFValues, Holder<java.util.List<java.lang.String>> VBoxValues, Holder<java.util.List<java.lang.String>> extraConfigValues)
          This is the same asgetDescription(Holder,Holder,Holder,Holder,Holder)except that you can specify which types should be returned.
 java.util.List<java.lang.String> getValuesByType(VirtualSystemDescriptionType type, VirtualSystemDescriptionValueType which)
          This is the same asgetDescriptionByType(org.virtualbox_5_2.VirtualSystemDescriptionType,Holder,Holder,Holder,Holder,Holder)except that you can specify which value types should be returned.
static IVirtualSystemDescription queryInterface(IUnknown obj)
           
 void setFinalValues(java.util.List<java.lang.Boolean> enabled, java.util.List<java.lang.String> VBoxValues, java.util.List<java.lang.String> extraConfigValues)
          This method allows the appliance's user to change the configuration for the virtual system descriptions.
 
Methods inherited from class org.virtualbox_5_2.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

IVirtualSystemDescription

public IVirtualSystemDescription(java.lang.String wrapped,
                                 org.virtualbox_5_2.ObjectRefManager objMgr,
                                 org.virtualbox_5_2.jaxws.VboxPortType port)
Method Detail

getCount

public java.lang.Long getCount()
Return the number of virtual system description entries.

Returns:
Long

queryInterface

public static IVirtualSystemDescription queryInterface(IUnknown obj)

getDescription

public void getDescription(Holder<java.util.List<VirtualSystemDescriptionType>> types,
                           Holder<java.util.List<java.lang.String>> refs,
                           Holder<java.util.List<java.lang.String>> OVFValues,
                           Holder<java.util.List<java.lang.String>> VBoxValues,
                           Holder<java.util.List<java.lang.String>> extraConfigValues)
Returns information about the virtual system as arrays of instruction items. In each array, the items with the same indices correspond and jointly represent an import instruction for VirtualBox. The list below identifies the value sets that are possible depending on theVirtualSystemDescriptionTypeenum value in the array item in aTypes[]. In each case, the array item with the same index in OVFValues[] will contain the original value as contained in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[] will contain a suggested value to be used for VirtualBox. Depending on the description type, the aExtraConfigValues[] array item may also be used.


getDescriptionByType

public void getDescriptionByType(VirtualSystemDescriptionType type,
                                 Holder<java.util.List<VirtualSystemDescriptionType>> types,
                                 Holder<java.util.List<java.lang.String>> refs,
                                 Holder<java.util.List<java.lang.String>> OVFValues,
                                 Holder<java.util.List<java.lang.String>> VBoxValues,
                                 Holder<java.util.List<java.lang.String>> extraConfigValues)
This is the same asgetDescription(Holder,Holder,Holder,Holder,Holder)except that you can specify which types should be returned.


getValuesByType

public java.util.List<java.lang.String> getValuesByType(VirtualSystemDescriptionType type,
                                                        VirtualSystemDescriptionValueType which)
This is the same asgetDescriptionByType(org.virtualbox_5_2.VirtualSystemDescriptionType,Holder,Holder,Holder,Holder,Holder)except that you can specify which value types should be returned. SeeVirtualSystemDescriptionValueTypefor possible values.


setFinalValues

public void setFinalValues(java.util.List<java.lang.Boolean> enabled,
                           java.util.List<java.lang.String> VBoxValues,
                           java.util.List<java.lang.String> extraConfigValues)
This method allows the appliance's user to change the configuration for the virtual system descriptions. For each array item returned fromgetDescription(Holder,Holder,Holder,Holder,Holder), you must pass in one boolean value and one configuration value. Each item in the boolean array determines whether the particular configuration item should be enabled. You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA, HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController and SoundCard. For the "vbox" and "extra configuration" values, if you pass in the same arrays as returned in the aVBoxValues and aExtraConfigValues arrays fromgetDescription(Holder,Holder,Holder,Holder,Holder), the configuration remains unchanged. Please see the documentation forgetDescription(Holder,Holder,Holder,Holder,Holder)for valid configuration values for the individual array item types. If the corresponding item in the aEnabled array is false, the configuration value is ignored.


addDescription

public void addDescription(VirtualSystemDescriptionType type,
                           java.lang.String VBoxValue,
                           java.lang.String extraConfigValue)
This method adds an additional description entry to the stack of already available descriptions for this virtual system. This is handy for writing values which aren't directly supported by VirtualBox. One example would be the License type ofVirtualSystemDescriptionType.