Interface IHostResource

  • All Known Subinterfaces:
    IDataSet, IGenerationDataGroup, IMember, IMigratedDataSet, IPartitionedDataSet, IPartitionedDataSetMember, ISequentialDataSet, IVSAMCluster

    public interface IHostResource
    A resource that resides on a host.

    The state of this resource is a snapshot of this resource from the time it was retrieved from the host. In order to retrieve the current state of this resource, it will need to be re-retrieved from the host.

    Note: Subclasses may provide methods that retrieve data related to this resource at the time those methods are called. Such methods will be named with a prefix of "fetch" or "find" instead of "get", and the data retrieved from those methods will represent the state of that data from the time those methods are called, instead of the time that this resource was retrieved.

    Since:
    1.0.0
    Version:
    2.0.0
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Detail

      • getHostConnection

        IHostConnection getHostConnection()
        Returns the host connection used to obtained this host resource.
        Returns:
        the host connection
        Since:
        1.0.0
      • getName

        String getName()
        Returns the name of this host resource.

        Note: the value returned from this method represents the state of this host resource from the time it was retrieved from the host. Any changes made to this host resource since it was retrieved will not be reflected in this method.

        Returns:
        a String name
        Since:
        1.0.0
      • getType

        HostResourceType getType()
        Returns the type of this host resource.

        Note: the value returned from this method represents the state of this host resource from the time it was retrieved from the host. Any changes made to this host resource since it was retrieved will not be reflected in this method.

        Returns:
        a HostResourceType
        Since:
        1.0.0