com.ibm.websphere.sca.mq.data

Interface MQBodyObjectBinding

  • All Superinterfaces:
    commonj.connector.runtime.DataBinding, MQBodyDataBinding, java.io.Serializable


    public interface MQBodyObjectBinding
    extends MQBodyDataBinding
    A DataBinding represents the mapping between a native data format and an SDO DataObject, and vice-versa.

    This interface is a further extension of commonj.connector.runtime.DataBinding based on the MQBodyDataBinding interface. It exposes methods to support the transport of java.lang.Objects, as well as DataObjects as supported by the parent class.

    See Also:
    DataBinding
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.Object getObject()
      Returns the Object created by this DataBinding implementation (in the read method) to the runtime.
      boolean isObjectType()
      Used by the runtime to query whether the payload received by the DataBinding is an Object or a DataObject.
      void setObject(java.lang.Object inObject)
      This method is called by the runtime to prime the DataBinding, prior to the write method being invoked to serialize the Object to an outgoing WMQ message.
      void setObjectType(boolean isObject)
      Used by the runtime to indicate to the DataBinding that the input value to be serialized by the write method is an Object (set by setObject) and not a DataObject (set by setDataObject).
      • Methods inherited from interface commonj.connector.runtime.DataBinding

        getDataObject, setDataObject
    • Method Detail

      • setObject

        void setObject(java.lang.Object inObject)
                       throws commonj.connector.runtime.DataBindingException
        This method is called by the runtime to prime the DataBinding, prior to the write method being invoked to serialize the Object to an outgoing WMQ message.
        Parameters:
        inObject - The Object to be serialized by the write method.
        Throws:
        commonj.connector.runtime.DataBindingException - Thrown if error occurs during serialization of the Object.
      • getObject

        java.lang.Object getObject()
                                   throws commonj.connector.runtime.DataBindingException
        Returns the Object created by this DataBinding implementation (in the read method) to the runtime.
        Returns:
        The generated Object.
        Throws:
        commonj.connector.runtime.DataBindingException - Thrown if error occurs during creation of the Object.
      • isObjectType

        boolean isObjectType()
        Used by the runtime to query whether the payload received by the DataBinding is an Object or a DataObject. The runtime will then call getObject or getDataObject as appropriate.
        Returns:
        A boolean specifying either Object or DataObject (false implies DataObject).
      • setObjectType

        void setObjectType(boolean isObject)
        Used by the runtime to indicate to the DataBinding that the input value to be serialized by the write method is an Object (set by setObject) and not a DataObject (set by setDataObject). The DataBinding will then serialize the Object to the outgoing WMQ message.
        Parameters:
        isObject - A boolean value indicating whether the payload is an Object or a DataObject.
IBM Business Process ManagerTM
Release 8