net.java.dev.vcc.api
Interface ComputerSnapshot

All Superinterfaces:
ManagedObject<ComputerSnapshot>
All Known Implementing Classes:
AbstractComputerSnapshot

public interface ComputerSnapshot
extends ManagedObject<ComputerSnapshot>

Represents a snapshot of a virtual computer.


Method Summary
 java.util.concurrent.Future<java.lang.Boolean> doDelete()
          Attempts to delete the snapshot.
 java.util.concurrent.Future<java.lang.Boolean> doRename(java.lang.String name)
          Attempts to rename the snapshot.
 java.util.concurrent.Future<java.lang.Boolean> doSetDescription(java.lang.String description)
          Attempts to modify the description of the snapshot.
 java.util.Set<ComputerSnapshot> getChildren()
          Gets the child snapshots of this snapshot.
 ComputerSnapshot getParent()
          Gets the parent snapshot from which this snapshot was derived.
 PowerState getState()
          Gets the state of the virtual computer when the snapshot was taken.
 
Methods inherited from interface net.java.dev.vcc.api.ManagedObject
execute, getCommands, getDescription, getId, getName
 

Method Detail

doRename

java.util.concurrent.Future<java.lang.Boolean> doRename(java.lang.String name)
Attempts to rename the snapshot.

Parameters:
name - the new name.
Returns:
a future for the operation which will return Boolean.TRUE if the operation was successful.

doSetDescription

java.util.concurrent.Future<java.lang.Boolean> doSetDescription(java.lang.String description)
Attempts to modify the description of the snapshot.

Parameters:
description - the new description.
Returns:
a future for the operation which will return Boolean.TRUE if the operation was successful.

doDelete

java.util.concurrent.Future<java.lang.Boolean> doDelete()
Attempts to delete the snapshot.

Returns:
a future for the operation which will return Boolean.TRUE if the operation was successful.

getParent

ComputerSnapshot getParent()
Gets the parent snapshot from which this snapshot was derived.

Returns:
the parent snapshot or null if this snapshot does not have a parent.

getChildren

java.util.Set<ComputerSnapshot> getChildren()
Gets the child snapshots of this snapshot.

Returns:
the collection of child snapshots (possibly empty).

getState

PowerState getState()
Gets the state of the virtual computer when the snapshot was taken.

Returns:
the state of the virtual computer when the snapshot was taken.


Copyright © 2009. All Rights Reserved.