com.ibm.cics.server

Class RetrievedData

  • java.lang.Object
    • com.ibm.cics.server.RetrievedData


  • public class RetrievedData
    extends java.lang.Object
    This class holds the data retrieved for a task that has been STARTed.
    Since CICS TS version:
    1.3
    Since package version:
    1.0.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      byte[] getData()
      Retrieve the data value.
      byte[] getQueue()
      Retrieve the name of a Temporary Storage Queue (TSQ) that was passed to the started task by the caller.
      java.lang.String getStringData()
      Retrieve the data value as text.
      java.lang.String getStringQueue()
      Retrieve the Queue value as text.
      java.lang.String getTermId()
      Retrieve the terminal id value.
      java.lang.String getTransId()
      Retrieve the transaction id value.
      void setQueueName(byte[] newQueueName)
      Allows the setting of the data value into the holder.
      void setTermid(java.lang.String newTermId)
      Allows the setting of the data value into the holder.
      void setTransid(java.lang.String newTransId)
      Allows the setting of the data value into the holder.
      void setValue(byte[] bytes)
      Allows the setting of the data value into the holder.
      • Methods inherited from class java.lang.Object

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

      • getData

        public byte[] getData()
        Retrieve the data value.
        Returns:
        the data in bytes
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0
      • getStringData

        public java.lang.String getStringData()
        Retrieve the data value as text. The data is assumed to be encoded in the LOCALCCSID. The behavior of this method when the bytes are not valid in the LOCALCCSID encoding is unspecified.
        Returns:
        the data value as a String
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0
      • getTransId

        public java.lang.String getTransId()
        Retrieve the transaction id value.
        Returns:
        the transaction id name
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0
      • getTermId

        public java.lang.String getTermId()
        Retrieve the terminal id value.
        Returns:
        the terminal name
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0
      • getQueue

        public byte[] getQueue()
        Retrieve the name of a Temporary Storage Queue (TSQ) that was passed to the started task by the caller.
        Returns:
        the queue name in bytes. 1-8 characters long, or null if not asked for.
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0
      • getStringQueue

        public java.lang.String getStringQueue()
        Retrieve the Queue value as text. The Queue name is assumed to be encoded in the LOCALCCSID. The behavior of this method when the bytes are not valid in the LOCALCCSID encoding is unspecified.
        Returns:
        the Queue name value as a String
        Since CICS TS version:
        5.1
        Since package version:
        1.401.0
      • setValue

        public void setValue(byte[] bytes)
        Allows the setting of the data value into the holder.
        Parameters:
        bytes - The payload of the record holder.
        Since CICS TS version:
        6.1
        Since package version:
        2.0.0
      • setQueueName

        public void setQueueName(byte[] newQueueName)
        Allows the setting of the data value into the holder.
        Parameters:
        newQueueName - The new queuename
        Since CICS TS version:
        6.1
        Since package version:
        2.0.0
      • setTermid

        public void setTermid(java.lang.String newTermId)
        Allows the setting of the data value into the holder.
        Parameters:
        newTermId - The new termid
        Since CICS TS version:
        6.1
        Since package version:
        2.0.0
      • setTransid

        public void setTransid(java.lang.String newTransId)
        Allows the setting of the data value into the holder.
        Parameters:
        newTransId - The new transid
        Since CICS TS version:
        6.1
        Since package version:
        2.0.0