Interface ISysoutDataDefinition

  • All Known Subinterfaces:
    ISystemLogDataDefinition

    public interface ISysoutDataDefinition
    A Sysout Data Definition (DD).

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

    Examples:
    To retrieve the sysout data definitions for a job from an IJESCommandProvider:

     IJESCommandProvider commandProvider = ...
     IJobInfo jobInfo = ...
     
     List<ISysoutDataDefinition> dataDefinitions = commandProvider
             .fetchSysoutDataDefinitions(jobInfo);
     
    To retrieve the sysout data definitions for a job from an IJob:
     IJob job = ...
     
     List<ISysoutDataDefinition> dataDefinitions = job
             .fetchSysoutDataDefinitions();
     
    For examples on how to obtain an IJESCommandProvider see IJESCommandProvider.
    For examples on how to obtain an IJob see IJob.
    Since:
    2.2.0
    Version:
    2.3.0
    See Also:
    IJESCommandProvider, IJob
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Detail

      • getName

        String getName()
        Returns the name of this data definition.
        Returns:
        the data definition name
        Since:
        2.2.0
      • getStepName

        String getStepName()
        Returns the name of the step this data definition was created in.
        Returns:
        the step name
        Since:
        2.2.0
      • getDestination

        String getDestination()
        Returns the destination of this data definition.
        Returns:
        the destination
        Since:
        2.2.0
      • getOutputClass

        String getOutputClass()
        Returns output class of this sysout data definition.
        Returns:
        the output class
        Since:
        2.2.0
      • getRecordCount

        int getRecordCount()
        Returns the number of records/lines in the sysout dataset.
        Returns:
        the record count
        Since:
        2.2.0
      • getDataSetID

        String getDataSetID()
        Returns the JES ID of the sysout dataset (DSID).
        Returns:
        the dataset ID
        Since:
        2.2.0