com.ibm.dbb.build.report.records

Class Reference



  • public class Reference
    extends Record
    The Reference is a special type of Record that does not contain any information. It only contains ID and type of the reference of the actual record.
    • Constructor Summary

      Constructors 
      Constructor and Description
      Reference()
      Construct a record with a default ID
      Reference(java.lang.String id)
      Construct a reference with a specific ID.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getRefId()
      Return the ID of the actual record that this reference is referring to.
      java.lang.String getRefType()
      Return the type of the actual record that this reference is referring to.
      Record parse(com.ibm.json.java.JSONObject jsonObj)
      Create the record from JSON.
      void setRefId(java.lang.String refId)
      Set the ID of the actual record that this reference is referring to.
      void setRefType(java.lang.String refType)
      Set the type of the actual record that this reference is referring to.
      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

      • Reference

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

        public Reference(java.lang.String id)
        Construct a reference with a specific ID.
        Parameters:
        id - the ID of the reference.
    • Method Detail

      • getRefId

        public java.lang.String getRefId()
        Return the ID of the actual record that this reference is referring to.
        Returns:
        the ID of the actual record.
      • setRefId

        public void setRefId(java.lang.String refId)
        Set the ID of the actual record that this reference is referring to.
        Parameters:
        refId - the ID of the actual record.
      • getRefType

        public java.lang.String getRefType()
        Return the type of the actual record that this reference is referring to.
        Returns:
        the type of the actual record.
      • setRefType

        public void setRefType(java.lang.String refType)
        Set the type of the actual record that this reference is referring to.
        Parameters:
        refType - the type of the actual record.
      • 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 Record parse(com.ibm.json.java.JSONObject jsonObj)
        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.

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