net.java.dev.vcc.api.HostResourceContainer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vcc-api Show documentation

The API for control of virtual computers running on a virtual computer host

The newest version!

package net.java.dev.vcc.api;

import java.util.Set;

/**
 * Marker interface for a container of host resources.
 */
interface HostResourceContainer {
    /**
     * Gets all the virtual computers that are contained in this container.
     *
     * @return the virtual computers that are contained in this container.
     */
    Set getComputers();

    /**
     * Gets alll the {@link net.java.dev.vcc.api.HostResourceGroup}s that are contained in this container.
     *
     * @return the {@link net.java.dev.vcc.api.HostResourceGroup}s that are contained in this container.
     */
    Set getHostResourceGroups();

    /**
     * Gets all the computer templates that are contained in this container.
     *
     * @return the computer templates that are contained in this container.
     */
    Set getComputerTemplates();

    /**
     * Gets all the virtual computers that are contained in this container including children.
     *
     * @return the virtual computers that are contained in this container including children.
     */
    Set getAllComputers();

    /**
     * Gets all the computer templates that are contained in this container including children.
     *
     * @return the computer templates that are contained in this container including children.
     */
    Set getAllComputerTemplates();

    /**
     * Gets all the {@link net.java.dev.vcc.api.HostResourceGroup}s that are contained in this container including
     * children.
     *
     * @return the {@link net.java.dev.vcc.api.HostResourceGroup}s that are contained in this container including
     *         children.
     */
    Set getAllHostResourceGroups();
}