Package dev.galasa.zosbatch

Interface IZosBatchJobOutputSpoolFile

public interface IZosBatchJobOutputSpoolFile
Represents the a spool file from a zOS Batch job

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDdname()
    Return the DD name associated with this zOS batch job spool file
    String
    getId()
    Return the id associated with this zOS batch job spool file
    String
    getJobid()
    Return the job id associated with this zOS batch job spool file
    String
    getJobname()
    Return the job name associated with this zOS batch job spool file
    String
    getProcstep()
    Return the JCL procedure step name associated with this zOS batch job spool file
    String
    getRecords()
    Return the content of this zOS batch job spool file
    long
    getSize()
    Return the size of this zOS batch job spool file
    String
    getStepname()
    Return the step name associated with this zOS batch job spool file
    long
    retrieve()
    Retrieve current content of spool file from zOS
    void
    saveToResultsArchive(String rasPath)
    Save this zOS batch job spool file to the Results Archive Store.
    void
    setRecords(String records)
    Set the records for this spool file, size is automatically updated with the size of the records

  • Method Details

    • getJobname

      String getJobname()
      Return the job name associated with this zOS batch job spool file
      Returns:
      the zOS batch job job name

    • getJobid

      String getJobid()
      Return the job id associated with this zOS batch job spool file
      Returns:
      the zOs batch job job id

    • getStepname

      String getStepname()
      Return the step name associated with this zOS batch job spool file
      Returns:
      the zOS batch job step name

    • getProcstep

      String getProcstep()
      Return the JCL procedure step name associated with this zOS batch job spool file
      Returns:
      the zOS batch job proc step name or an empty String

    • getDdname

      String getDdname()
      Return the DD name associated with this zOS batch job spool file
      Returns:
      the zOS batch job DD name

    • getId

      String getId()
      Return the id associated with this zOS batch job spool file
      Returns:
      the zOS batch job spool file ID

    • getSize

      long getSize() throws ZosBatchException
      Return the size of this zOS batch job spool file
      Returns:
      the zOS batch job spool file size
      Throws:
      ZosBatchException

    • retrieve

      long retrieve() throws ZosBatchException
      Retrieve current content of spool file from zOS
      Returns:
      the size of the data retrieved
      Throws:
      ZosBatchException

    • getRecords

      String getRecords()
      Return the content of this zOS batch job spool file
      Returns:
      the zOS batch job spool file content

    • setRecords

      void setRecords(String records)
      Set the records for this spool file, size is automatically updated with the size of the records
      Parameters:
      records - The records that make up this spool record

    • saveToResultsArchive

      void saveToResultsArchive(String rasPath) throws ZosBatchException
      Save this zOS batch job spool file to the Results Archive Store. Will only store records retrieved since the IZosBatchJobOutputSpoolFile object was created or the last retrieve() was issued
      Parameters:
      rasPath - path in Results Archive Store
      Throws:
      ZosBatchException