Interface ISystemLogDataDefinition

  • All Superinterfaces:
    ISysoutDataDefinition

    public interface ISystemLogDataDefinition
    extends ISysoutDataDefinition
    A System Log Data Definition

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

    Examples:
    To retrieve the system log data definitions for the currently active system log from an IJESCommandProvider:

     IJESCommandProvider commandProvider = ...
     IJobInfo jobInfo = ...
     
     ISystemLogDataDefinition dataDefinition = commandProvider.getActiveSystemLog();
     
    To retrieve the system log data definitions for all available system logs from an IJESCommandProvider:
     IJESCommandProvider commandProvider = ...
     
     ISystemLogDataDefinition dataDefinition = commandProvider.getSystemLogs(limit);
     
    For examples on how to obtain an IJESCommandProvider see IJESCommandProvider.
    Since:
    2.3.0
    Version:
    2.3.0
    See Also:
    IJESCommandProvider
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Detail

      • getJob

        IJob getJob()
        Returns the IJob for the system log job.
        Returns:
        The job.
        Since:
        2.3.0