com.ibm.dbb.build.report.records

Class ExecuteRecord



  • public class ExecuteRecord
    extends Record
    Create a record to store information about executing a command.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ExecuteRecord()
      Construct a record with a default ID
      ExecuteRecord(java.lang.String id)
      Construct a record with the supplied ID.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addDataset(java.lang.String dataset)
      Add the data set to be stored in the build report.
      void addLogFile(java.io.File logFile)
      Add the log file associated with the command.
      void addOutput(java.lang.String dataset, java.lang.String deployType)
      Add the output to be stored in the build report.
      java.lang.String getCommand()
      Return the command to be stored in the build report.
      java.util.List<java.lang.String> getDatasets()
      Return a list of data sets being stored in the build report.
      java.lang.String getFile()
      Return the file associated with the command.
      java.util.List<java.io.File> getLogFiles()
      Return a list of the log files associated with the command.
      java.lang.String getOptions()
      Return the options used by the command to be stored in the build report.
      java.util.List<ExecuteRecord.OutputInfo> getOutputs()
      Return the list of outputs being stored in the build report.
      int getRc()
      Return the RC associated with the command.
      ExecuteRecord parse(com.ibm.json.java.JSONObject jsonObj)
      Create the record from JSON.
      void setCommand(java.lang.String command)
      Set the command to be stored in the build report.
      void setFile(java.lang.String file)
      Set the file associated with the command to be stored in the build report.
      void setOptions(java.lang.String options)
      Set the options used by the command to be stored in the build report.
      void setRc(int rc)
      Set the RC associated with the command.
      com.ibm.json.java.JSONObject toJSON()
      Returns the record in JSON format.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ExecuteRecord

        public ExecuteRecord()
        Construct a record with a default ID
      • ExecuteRecord

        public ExecuteRecord(java.lang.String id)
        Construct a record with the supplied ID.
        Parameters:
        id - the id of the record.
    • Method Detail

      • getCommand

        public java.lang.String getCommand()
        Return the command to be stored in the build report.
        Returns:
        the command to be stored in the build report.
      • setCommand

        public void setCommand(java.lang.String command)
        Set the command to be stored in the build report.
        Parameters:
        command - the command to be stored in the build report.
      • getOptions

        public java.lang.String getOptions()
        Return the options used by the command to be stored in the build report.
        Returns:
        the options used by the command.
      • setOptions

        public void setOptions(java.lang.String options)
        Set the options used by the command to be stored in the build report.
        Parameters:
        options - the options used by the command.
      • getRc

        public int getRc()
        Return the RC associated with the command.
        Returns:
        the RC associated with the command.
      • setRc

        public void setRc(int rc)
        Set the RC associated with the command.
        Parameters:
        rc - the RC associated with the command.
      • addOutput

        public void addOutput(java.lang.String dataset,
                              java.lang.String deployType)
        Add the output to be stored in the build report.
        Parameters:
        dataset - the output to be stored in the build report.
        deployType - the output to be stored in the build report.
      • getOutputs

        public java.util.List<ExecuteRecord.OutputInfo> getOutputs()
        Return the list of outputs being stored in the build report.
        Returns:
        the list of outputs being stored in the build report.
      • setFile

        public void setFile(java.lang.String file)
        Set the file associated with the command to be stored in the build report.
        Parameters:
        file - the file associated with the command.
      • getFile

        public java.lang.String getFile()
        Return the file associated with the command.
        Returns:
        the file associated with the command.
      • addDataset

        public void addDataset(java.lang.String dataset)
        Add the data set to be stored in the build report.
        Parameters:
        dataset - the data set to be stored in the build report.
      • getDatasets

        public java.util.List<java.lang.String> getDatasets()
        Return a list of data sets being stored in the build report.
        Returns:
        the list of data sets being stored in the build report.
      • addLogFile

        public void addLogFile(java.io.File logFile)
        Add the log file associated with the command.
        Parameters:
        logFile - the log file associated with the command.
      • getLogFiles

        public java.util.List<java.io.File> getLogFiles()
        Return a list of the log files associated with the command.
        Returns:
        the list of the log files associated with the command.
      • toJSON

        public com.ibm.json.java.JSONObject toJSON()
        Returns the record in JSON format.
        Overrides:
        toJSON in class Record
        Returns:
        the JSON format of this record.
      • parse

        public ExecuteRecord parse(com.ibm.json.java.JSONObject jsonObj)
                            throws ParseException
        Create the record from JSON.
        Overrides:
        parse in class Record
        Parameters:
        jsonObj - The object in JSON to be parsed.
        Returns:
        the record representing by the supplied JSON contents.
        Throws:
        ParseException

<IBM Copyright © 2018 IBM Corp. All Rights Reserved.