Class GetJobs


  • public class GetJobs
    extends ZosConnection
    Class example to showcase GetJobs functionality.
    Version:
    1.0
    Author:
    Frank Giordano
    • Constructor Detail

      • GetJobs

        public GetJobs()
    • Method Detail

      • main

        public static void main​(String[] args)
                         throws Exception
        Main method defines z/OSMF host and user connection and other parameters needed to showcase GetJobs functionality. Calls GetJobs example methods.
        Parameters:
        args - for main not used
        Throws:
        Exception - error in processing request
      • getJclCommon

        public static void getJclCommon​(String prefix)
                                 throws Exception
        Example on how to call GetJobs getJclCommon method. getJclCommon is given CommonJobParams object filled with information on the given job to use for retrieval of its JCL content
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJclForJob

        public static void getJclForJob​(String prefix)
                                 throws Exception
        Example on how to call GetJobs getJclForJob method. getJclForJob is given a job object to use for retrieval of its JCL content
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJcl

        public static void getJcl​(String prefix)
                           throws Exception
        Example on how to call GetJobs getJcl method. getJcl is given a jobName and jobId values to use for retrieval of its JCL content
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getStatusForJob

        public static void getStatusForJob​(String prefix)
                                    throws Exception
        Example on how to call GetJobs getStatusForJob method. getStatusForJob is given a job object to use for retrieval of its status
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getStatus

        public static void getStatus​(String prefix)
                              throws Exception
        Example on how to call GetJobs getStatus method. getStatus is given a jobName and jobId value to use for retrieval of its status
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • nonExistentGetJob

        public static void nonExistentGetJob​(String jobId)
        Example on how to call GetJobs getJob method. getJob is given a jobId value for a non-existing job which will return an exception
        Parameters:
        jobId - jobId value
      • getJob

        public static void getJob​(String prefix)
                           throws Exception
        Example on how to call GetJobs getJob method. getJob is given a jobId value which will return a job document/object
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJobsByOwnerAndPrefix

        public static void getJobsByOwnerAndPrefix​(String owner,
                                                   String prefix)
                                            throws Exception
        Example on how to call GetJobs getJobsByOwnerAndPrefix method. getJobsByOwnerAndPrefix is given an owner and prefix values which will return a list of common job document/object
        Parameters:
        owner - owner value
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJobsByPrefix

        public static void getJobsByPrefix​(String prefix)
                                    throws Exception
        Example on how to call GetJobs getJobsByPrefix method. getJobsByPrefix is given a prefix value which will return a list of common job document/object
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJobs

        public static void getJobs()
                            throws Exception
        Example on how to call GetJobs' getJobs method. It returns a list of all jobs available for the logged-in user.
        Throws:
        Exception - error in processing request
      • getSpoolContent

        public static void getSpoolContent​(String prefix)
                                    throws Exception
        Example on how to call GetJobs getSpoolContent method. getSpoolContent is given a job spool file name to retrieve its content.
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJobsByOwner

        public static void getJobsByOwner​(String owner)
                                   throws Exception
        Example on how to call GetJobs getJobsByOwner method. getJobsByOwner is given an owner value to use retrieve a list of its available jobs.
        Parameters:
        owner - owner value
        Throws:
        Exception - error in processing request
      • getSpoolFilesForJob

        public static void getSpoolFilesForJob​(String prefix)
                                        throws Exception
        Example on how to call GetJobs getSpoolFilesForJob method. getSpoolFilesForJob is given a job document/object retrieve a list of all its spool names.
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getSpoolFiles

        public static void getSpoolFiles​(String prefix)
                                  throws Exception
        Example on how to call GetJobs getSpoolFiles method. getSpoolFiles is given a jobName and jobId values to retrieve a list of all its spool file names.
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request
      • getJobsCommon

        public static void getJobsCommon​(String prefix)
                                  throws Exception
        Example on how to call GetJobs getJobsCommon method. getJobsCommon is given a GetJobParams object filled with search parameters which will retrieve a list of all jobs.
        Parameters:
        prefix - partial or full job name to use for searching
        Throws:
        Exception - error in processing request